The API Design Blog

The #1 source of tips and tricks for building quality APIs with a Design-First Approach

API Documentation and Help Docs: Can They Live Together?

How your product audience determines the relationship between your API Documenta...

Luke Russell
Luke Russell
March 9 2021

A Practical Guide to API Design-First

An overview of the API Design-First philosophy and how Stoplight and Git can pow...

Nauman Ali
Nauman Ali
February 8 2021

Export API Documentation as a PDF

Using OpenAPI to create PDF based reference documentation for clients and other ...

Phil Sturgeon
Phil Sturgeon
January 4 2021

Deprecating API Endpoints

Deprecation communicates a function, method, or entire package is going away or ...

Phil Sturgeon
Phil Sturgeon
December 4 2020

How OpenAPI Data Types Enable Robust APIs

How JSON and JSON Schema impacted the OpenAPI format and what’s possible with yo...

Adam DuVander
Adam DuVander
October 12 2020

Generating API Documentation from Code with Stoplight

Working with the code-first workflow, using annotations in code to describe your...

Phil Sturgeon
Phil Sturgeon
October 6 2020

What's the Difference Between OpenAPI Types 2.0, 3.0, and 3.1?

A deep look into different OpenAPI versions starting from 2.0 to the latest rele...

Janet Wagner
Janet Wagner
September 29 2020

Is API Planning the same thing as API Design?

Exploring the various approaches for planning an API, whether you follow the API...

Phil Sturgeon
Phil Sturgeon
August 10 2020

What is the Meaning of API Testing?

Types of API Testing: contract testing, unit testing, integration testing. Let's...

Phil Sturgeon
Phil Sturgeon
July 10 2020

Just a Simple API: List of APIs with Fun Data for Quick Mock-ups

Todos, Entertainment, and APIs That Are Out of This World (Literally)

Luke Russell
Luke Russell
July 8 2020
Peek-a-Boo

Subscribe for the latest in API Design

By submitting this you will be receiving our latest updates on post.

Take a Listen to API Intersection

The podcast on the intersection between API design & digital transformation
Listen