rswag VS springfox

We will be creating a "Coffee Ordering API" using Ruby on Rails, and using a tool called rswag to create tests that verify the behaviour of our API and generate an OpenAPI reference.

Made a library a while back that helped me write JSON schemas for rswag. Hope others find it useful!

Forem, which is a Ruby on Rails app, integrates Swagger via a gem - the rswag gem. The rswag Ruby gem allows us to create a Swagger-based DSL for describing and testing our API operations. It also extends rspec-rails "request specs”, hence, allowing our documentation to be a part of our test suite which allows us to make requests with test parameters and seed data that invoke different response codes. As a result, we are able to test what the requests and responses look like, however we do not test the business logic that drives the endpoint - that is tested elsewhere in the code.

Using something like rswag will give you some ability, in the specs, to also describe the endpoints and auto-generate some documentation.

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.

https://github.com/rswag/rswag - helps generate Swagger documentation (you can upload it to an external service, like readme.com or serve from your Rails app)

rswag expands the "request specifications" of rspec-rails with a Swagger-based DSL for defining and testing API activities. - Github

Hello guys, I'm working on a rails (4.x) project, trying to implement a way to create docs for OpenApi 3 and Swagger (I started to learn rails in october last year), this project has like 6 years old, a lot of endpoints and very poor documentation, my first option is Rswag, does anyone knows a good example project for these gem?

I'm using the Rswag gem to document my API. Right now I have a WIP here: https://cabal-fintech.herokuapp.com/api-docs/v1/swagger.json but whenever I try to validate it on the swagger validator I get an error not even understandable to me, as that route doesn't need [params].item

The only issue I saw on this is that controllers get a lot more cluttered. See an example.

Examples include Swagger-Core, SpringFox, NSwag / Swashbuckle, Swagger-express / HAPI-Swagger, Django-REST-Swagger / Flask-RESTplus, etc.

From a casual Google search - short answer, yes. Longer answer, see the link.

If Java and Spring, you can use SpringFox: write unit tests and get generated API docs as a bonus.

It seems that there might be some other configuration as the error traces back to springfox.io.

Teams that use spring can easily create specs by using Spring Fox https://github.com/springfox/springfox