OpenAPI for all

OpenAPI is not perfect because specifications are complicated, and this is because people are complicated. The more people involved, the harder it is to match every use case and get everyone to agree. I personally never had too many issues with OpenAPI beyond conditional schemas because OpenAPI does such a great job. We should be proud of how far OpenAPI has come.

You only have to look at something like Web Components to see how adopting something as an industry can cause a lot of drama.

-- Alexander

The API Round-Up

The Complete Guide to OpenAPI v3.1

Somehow, in between his spare moments of saving the planet, Phil has found time to write a complete guide to OpenAPI for Bump.sh. This guide covers anything you'll likely need to know for v3.1, from an introduction to responses to extensions and advanced parts of the specification. It's a handy tool and a great read.

OpenAPI 3.1 - The Cheat Sheet

It does exactly what it says on the tin. Print it off, stick it on your desk, and see exactly what combination of keywords you need to solve common tasks. A huge thank you to everyone who helped put this together. It's a fantastic reference for everyone using OpenAPI.

Spectral Governance for Arazzo and API Workflows

Want to learn how Arazzo works but don't have a clue? Let Spectral show you the way! For those using Spectral (an open-source API linter), enable Arazzo linting, and you are good to go.

Content Engine for your API Docs and Product Guides

Hashnode recently launched a new product on top of its fantastic blogging tools: docs for APIs and products. Their blogging tools are a breeze to use, so hopefully, this same user experience extends to their docs. You can set up your API docs super quickly by importing your OpenAPI specs.

Generate an OpenAPI spec from tRPC

tRPC gives TypeScript devs a type-safe pattern for creating and consuming apis - and is compatible with many frameworks from Remix to Next.js, Vue and SolidJS. This guide shows you how to generate a tidy OpenAPI spec from an existing tRPC config.

Fastify v5 is Now Officially Released!

Fastify just pushed a new major version. I often consider Fastify a modern alternative to Express. Its OpenAPI integration is beautiful and helps speed up your application by integrating your JSON Schemas.

Speakeasy: Build APIs Your Users Love

Your API deserves a great developer experience. Get one by using Speakeasy to generate idiomatic, type-safe SDKs from OpenAPI

Start Generating

From Our Community

Articles written and shared in our free Slack community

TypeSpec Reminds Us Why OpenAPI Exists in the First Place

Following on from the theme of this newsletter's intro, Fabrizio Ferri Benedetti talks us through his thoughts on TypeSpec. His words, "Design is hard because it's a human problem", really hit home and highlight the reasons OpenAPI exists in the first place.

Analyzing the OpenAPI Tooling Ecosystem

The incredible Henry Andrews has started a new blog series that reviews the tools from the API ecosystem. It's a fascinating read, and I can't wait for the next one.

Thanks so much to our members: Al N, Kin L, Juxt, Alex R, Nolan S, Frank, James D, Bill D, and Ali S. Your support means the world to us!

Until next time,

Alexander, Phil & Mike