APIs You Won't Hate

API development is a topic very close to our hearts. APIs You Won’t Hate started out as a book, with founder Phil pouring everything API related he knew, all the problems he faced, all the design decisions he wish he thought about earlier.

Generating OpenAPI docs for Ruby on Rails with RSwag

--

API Code-first is the art of building an API, and then popping some annotations or metadata in there to output API documentation in an API description format like OpenAPI.

The most popular API Code-first approach in Ruby on Rails uses a tool called RSwag. With RSwag you write the OpenAPI for each API endpoint into special tests, which help to confirm your responses are matching the OpenAPI you’ve just written.

Read the full guide over on Bump.sh.

https://docs.bump.sh/guides/openapi/code-first-rails/

--

--

APIs You Won't Hate
APIs You Won't Hate

Published in APIs You Won't Hate

API development is a topic very close to our hearts. APIs You Won’t Hate started out as a book, with founder Phil pouring everything API related he knew, all the problems he faced, all the design decisions he wish he thought about earlier.

Phil Sturgeon
Phil Sturgeon

Written by Phil Sturgeon

Bike nomad turned electric van nomad, boycotting fossil-fuels, working on reforestation and ancient woodland restoration as co-founder of Protect Earth. he/him

No responses yet