Co-founder of APIs You Won't Hate, and part techie, part woodland creation, and ancient woodland restoration. Co-founder of @ProtectEarthUK. @philsturgeon@mastodon.green
Explore the balance between traditional API design and innovative low/no-code solutions in API development. Uncover insights from an expert's journey, highlighting the practicality and trade-offs of these approaches. Perfect for API developers and tech enthusiasts.
openapi
Master the use of $ref in OpenAPI and AsyncAPI to manage complex YAML/JSON documents, reduce merge conflicts, and streamline your API descriptions.
When OpenAPI or JSON Schema documents get massive or repetitive, the contents can be split across multiple documents (on the filesystem, URLs, in memory somewhere) and joined together $ref. These split up API descriptions can then be joined back together as one document, with $ref pointing to an internal location
Redocly CLI is a brilliant new tool from the folks who made ReDoc, the first beautiful API reference documentation tool powered by OpenAPI. This CLI tool goes a lot further than documentation, and helps with “linting” (automated API Style Guides), and solves the biggest problem that I had previously been
api-design
Explore idempotency in HTTP, highlighting its importance in preventing unintended effects of repeated actions. Learn how methods like GET, PUT, and DELETE inherently support idempotency, ensuring consistent results.
api-design
Step into the future of API tooling with this video Phil Sturgeon recorded for Treblle's Hacktoberfest called "Modern OpenAPI Tooling."
Recently I was talking with the Trebble team on a "X Space" they were hosting all about API versioning, and one topic came up which I wanted to delve into further: Semantic Versioning for API Versions.
codegen
Generate TypeScript client code easily with Fern, an automated tool that builds SDKs for major languages, Postman Collections, and OpenAPI definitions. Avoid the slow and brittle manual process, and publish directly to package repositories like NPM.
api-design
When rewriting an API, it's critical to make sure you don't change the shape of your inputs and outputs unexpectedly. After all, API specs are called contracts for a reason. This article outlines an approach to capturing API traffic using Optic for just this purpose.
This article is sponsored by APIMatic, in that they're paying for our time to review their product, but they're not paying for what we write. If it's rubbish, we'll let you know. I've used APIMatic a fair bit in the
openapi
Capture real HTTP traffic from production or anywhere else, and create OpenAPI from it, for documentation, mocks, SDKs, or contract testing.
Recently I've been on a run of making new all powerful Spectral rulesets, but so far it's been focused on the concept of automating style guides, with the concrete example of the APIs You Won't Hate: API Style Guide showing how it can be