/plushcap/analysis/bump/documenting-ruby-on-rails-apis-openapi

Documenting Ruby on Rails APIs with OpenAPI

What's this blog post about?

The text discusses the documentation of Ruby on Rails APIs using OpenAPI. It mentions Phil Sturgeon, an API expert and reforester, who is an evangelist for OpenAPI. The text introduces a new knowledge base that supports API builders in their daily jobs, offering guides and tutorials for building REST or Event-driven APIs. The key topic discussed with the community is best practices in writing OpenAPI contracts while working with Ruby on Rails. It talks about code-first and design-first approaches to writing OpenAPI contracts, emphasizing that the right tools and practices are important. The text also discusses generating OpenAPI docs from code using RSpec and Rswag, adding headers, schemas, responses, etc., building robust API contracts, and avoiding technical debt by writing an OpenAPI contract. The text concludes with a mention of sample OpenAPI files available on GitHub repositories and deployed on Bump.sh, and invites readers to enjoy the guides and contribute their expertise.

Company
Bump

Date published
Feb. 21, 2024

Author(s)
Christophe Dujarric

Word count
478

Language
English

Hacker News points
None found.


By Matt Makai. 2021-2024.