jonas.splinter
Search
Topic

APIs

How systems talk to each other: designing, documenting and using APIs. Front ends, back ends, workflows and AI assistants all depend on them.

An application programming interface is a contract between two pieces of software. One side promises which requests it accepts and what it returns, and the other side relies on that promise. On the web this usually means HTTP endpoints that exchange JSON. The OpenAPI Specification, maintained by the OpenAPI Initiative under the Linux Foundation, is the common way to describe such an API in a machine-readable file, from which documentation, tests and client code can be generated.

APIs are the glue in my kind of work. A front end with a separate Laravel back end, a workflow in n8n that moves data between services, an assistant that searches a directory through MCP: each depends on one system asking another for data in an agreed format.

What I value most in an API is predictability: a consistent response shape, clear versioning, and errors that say what went wrong instead of an empty result. A failure that looks like valid data is the most expensive kind, because nobody notices it until the numbers are wrong.

2 blog posts

Longer articles about APIs

1 update

About APIs, from Personal only

Personal

An API-first rule for everything I run

New house rule: every system I run shares its data only through its own API. No shortcuts between systems, which keeps the whole setup simpler and safer.