THE API DESIGN BLOG

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

Subscribe
Export API Documentation as a PDF

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

Read
Phil Sturgeon
Jan 4, 2021
Deprecating API Endpoints

How do you warn API consumers developers when an API or endpoint is going away?

Read
Phil Sturgeon
Dec 4, 2020
Generating API Documentation from Code with Stoplight

Regardless of whether you use code-first or design-first, Stoplight is here to help.

Read
Phil Sturgeon
Oct 6, 2020
Is API Planning the Same Thing as API Design?

Exploring the stages that make up the API planning process for code-first and design-first teams.

Read
Phil Sturgeon
Aug 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)

Read
Luke Russell
Jul 8, 2020
How to Create an API in Three Steps

Design, verify, and code your way to a robust API

Read
Luke Russell
May 11, 2020
API Design-First vs Code First

With API descriptions rising in popularity, the main question I hear folks asking about is "API Design-first" or "code-first". This is a bit of a misleading question because these ...

Read
Phil Sturgeon
Apr 8, 2020
API Keys: API Authentication Methods & Examples

When and Where to Use API Keys

Read
Maggie Summers
Mar 25, 2020
Keeping OpenAPI DRY and Portable

Bundling, dereferencing, and how to use them in Stoplight Studio and CLI workflows.

Read
Phil Sturgeon
Mar 11, 2020
API Design Patterns for REST API Web Services Design

Best Practices for Designing and Developing RESTful APIs

Read
Adam DuVander
Feb 25, 2020