swagger-docs
Apipie
| swagger-docs | Apipie | |
|---|---|---|
| 1 | 2 | |
| 746 | 2,449 | |
| - | 0.3% | |
| 10.0 | 6.8 | |
| over 6 years ago | 29 days ago | |
| Ruby | Ruby | |
| MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
swagger-docs
-
Is there a way to easily autogenerate API documentation for a Ruby on Rails API?
Hello! I would like to autogenerate API documentation for my Ruby on Rails Application. However, all of the solutions I've found such as https://github.com/rswag/rswag and https://github.com/richhollis/swagger-docs involve writing tests or manually describing the endpoint responses. I am hoping to find something similar to Swashbuckle for ASP.Net Core but for Ruby on Rails. Below is an example of using Swashbuckle's ASP.NET Core to autogenerate Swagger API documentation. The response type is inferred form the return type of the action.
Apipie
- Is there a way to easily autogenerate API documentation for a Ruby on Rails API?
-
OpenAPI/Swagger comment parser for ruby
This gem takes directives in your controllers and can output swagger.json. It takes some work but it is nice that it can provide examples by capturing test output and because of this it doesn't get out of date as easily. https://github.com/Apipie/apipie-rails
What are some alternatives?
brick - Auto-generate models, views, controllers, and routes in a Rails app based on database structure
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
rswag - Seamlessly adds a Swagger to Rails-based API's
rspec_api_documentation - Automatically generate API documentation from RSpec
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
RDoc - RDoc produces HTML and online documentation for Ruby projects.
Annotate - Annotate Rails classes with schema and routes info
Hanna - RDoc generator designed with simplicity, beauty and ease of browsing in mind
Apidoco - Ruby on Rails API documentation tool
Hologram - A markdown based documentation system for style guides.
Documentation - A Rails engine to provide the ability to add documentation to a Rails application