written by Karl Hughes
While having accurate, up-to-date documentation is vital, it’s not enough. Creating content to support your documentation is a great way to help users solve their own problems and get started faster.
Books for API Developers
Build APIs You Won't Hate
Everyone and their dog wants an API, so you should probably learn how to build them.
More API goodness
Modern API Deployment Options in the Cloud
May 04, 2022
Creating an API for your backend doesn't need to be complicated. Let's explore some options for bootstrapping an API using modern tools.
Contract Testing a Laravel API with OpenAPI
Feb 04, 2022
Keeping your API and OpenAPI in sync doesn't have to be complicated, the Laravel PHP edition.
Eight of the Biggest Lies in APIs
Jan 12, 2022
In the API space, numerous statements are context-dependent, misunderstandings, or outright lies. Here are some of the biggest the APIs You Won't Hate community has heard to date.
Creating OpenAPI from HTTP Traffic
Jan 01, 2022
If you want to get into API design-first, but awkwardly already have a bunch of APIs with no OpenAPI, use a HTTP proxy like Akita to create OpenAPI from your HTTP traffic!
JSON Schema Bundling Finally Formalised
Aug 04, 2021
Existing tooling developers have created their own approaches to bundling JSON Schema and OpenAPI documents, but that can lead to errors. Bundling is now standardised.
Why Show Users Garbage API Errors?
May 14, 2021
What happens in your client application when an API error pops up beyond the common cases of Logged Out, Not Found, etc.? Do you vomit random API error codes and exception class names all over your end users screens, pointlessly confusing the hell out of them?
There's No Reason to Write OpenAPI By Hand
Mar 30, 2020
Sometimes you see people complaining about OpenAPI (formerly Swagger), saying they don't want to to write out a whole bunch of YAML/JSON by hand. Other than disability, there's no reason you need to do that, and there hasn't be for a long time. Whether you pick code-first or design-first, you've got some options.
OpenAPI v3.1 and JSON Schema
Feb 03, 2020
JSON Schema and OpenAPI will no longer have minor differences in the schema object, but will finally be compatible from OpenAPI v3.1.
Easy to Follow Hypermedia Controls with Ketting
Nov 22, 2019
Automated Style Guides for REST, GraphQL and gRPC
Nov 05, 2019
Create API style guides using linting tools for any API paradigm. Avoid "API Governance" teams sitting there reviewing every single API change that comes through, and automate that menial task away to the bots.
OpenAPI Callbacks and Webhooks
Oct 24, 2019
What's the difference between a callback and a webhook, and which does OpenAPI support? Read on to find out the current status and upcoming changes for asynchronous and two-way APIs.