Show HN: An OpenAPI guide written for developers

9 points

2 years ago

Hey HN! I work at Speakeasy building SDK generation and general API tooling. As part of our work, we’ve been helping a lot of companies improve the overall quality of their OpenAPI documents. As popular as OpenAPI is, there is a shocking lack of good information for developers who are trying to learn how to effectively work with the standard.

To fix that, we have put together the full OpenAPI reference guide that we would’ve like to have had when we were starting out:

- It is up to date, with information about v3.1 and callouts about where it differs from 3.0 - Features AI-powered search to make it easy to answer your questions - Is opinionated about the choices you can make - Rich with practical examples, interactive code sample, and explanations about how OpenAPI can effect downstream applications - Details about some of the proposed additions to OpenAPI that aren’t formally part of the spec, but play an increasingly important part in the tooling ecosystem (i.e. overlays & workflows)

The reference is open source (feel free to use it) and we’re actively welcoming contributors who want to help maintain it.

We're excited to hear what you all think, and hope this becomes a useful resource to anyone learning about OpenAPI!

https://www.speakeasyapi.dev/openapi https://github.com/speakeasy-api/openapi-reference-documenta...