Awesome API Documentation

A curated list of excellent API documentation tooling, workflows, and best practices.

Contents

• The Gold Standards (Examples)
• Specifications & Standards
• Documentation Frameworks & Platforms
• SDK & Snippet Generation
• The DX Workflow (Utilities)
• Discovery, Search & Localization
• Learning Path: Master API Docs
• Ecosystem & Services
• Contributing

The Gold Standards (Examples)

Showcasing the best API documentation in the wild. Found a great one? Open a PR!

Company	Layout Style	Why it's Awesome
Stripe	3-Column	The industry benchmark for interactivity.
Twilio	Tutorial-First	Incredible copy-paste code samples.
Plaid	Interactive	Best-in-class sandbox/test environment.
WorkOS	Visual-Led	Excellent use of diagrams for auth flows.

Specifications & Standards

The source of truth for your API design.

Spec-First (REST)

• OpenAPI Specification - The standard for describing RESTful APIs.
• API Blueprint - A high-level API design language.

Spec-First (Event-Driven/Other)

• AsyncAPI - Standard for message-driven architectures.
• GraphQL - Query language and runtime for APIs.

Code-First Tools

• TypeDoc - Generates API reference from TypeScript source.
• JSDoc - API documentation generator for JavaScript.

Documentation Frameworks & Platforms

Engines to render and host your documentation.

Managed Platforms (SaaS)

• Mintlify - Modern, AI-ready docs optimized for speed.
• ReadMe - Interactive developer hubs and onboarding.
• Stoplight - Design-first platform for API modeling.
• GitBook - Collaborative technical documentation.

Open Source / Self-Hosted

• Docusaurus - Powerful React-based docs-as-code framework.
• Swagger UI - OpenAPI interactive reference renderer.
• Redoc - Clean, customizable 3-column reference.
• MkDocs - Fast and simple static site generator.
• Docsify - Lightweight generator without a build step.

SDK & Snippet Generation

Documentation is only as good as the code a developer can actually run.

• Speakeasy - High-fidelity SDK generation (TS, Python, Go) that integrates into your docs.
• Fern - End-to-end tool for generating both your documentation site and your SDKs from one definition.
• Liblab - Automated SDK pipeline with built-in security and validation.
• APIMatic - Enterprise-grade SDK generation and developer experience portal.

The DX Workflow (Utilities)

Tools to validate, automate, and enhance the documentation pipeline.

Governance & Quality (Linting)

• Spectral - Linter for OpenAPI, AsyncAPI, and JSON Schema.
• Vale - Syntax-aware linter for technical prose.
• Dredd - Validates API docs against backend implementation.

Automation & Tooling

• OpenAPI Generator - Generate SDKs and samples from specs.
• Prism - Mock servers and contract testing from OpenAPI.
• Mermaid - Diagrams-as-code for flowcharts and sequence diagrams.

Discovery, Search & Localization

Helping developers find, navigate, and understand APIs across languages.

Search & Navigation

• Algolia DocSearch - The gold standard for documentation search.
• Meilisearch - Lightning-fast, open-source search for docs.
• Typesense - Open-source alternative for instant search experiences.

API Clients (Testing & Exploration)

• Postman - The ubiquitous client for API testing and collection-based docs.
• Insomnia - Open-source desktop client with a focus on simplicity and GraphQL support.
• Hoppscotch - Lightweight, browser-based open-source API development tool.

Internal Developer Portals (IDP)

• Backstage - Spotify's open-source platform for building developer portals.
• Port - No-code developer portal to manage docs and assets.
• Compass - Atlassian tool for tracking distributed services and docs.

Localization & Versioning

• Crowdin - Cloud-based localization management for technical docs.
• Lokalise - Tool for managing translations in docs-as-code workflows.
• Transifex - Continuous localization for fast-moving API products.

Learning Path: Master API Docs

A collection of resources to help technical writers and engineers improve their craft.

Courses & Tutorials

• Google Technical Writing Courses - Foundational writing for engineers.
• I'd Rather Be Writing - Tom Johnson's comprehensive API documentation course.
• API Documentation for Developers - Practical modular courses on Udemy.

Style Guides & Best Practices

• Google Developer Documentation Style Guide - Industry standard for technical voice and tone.
• Microsoft Writing Style Guide - Deep dive into grammar and clarity for tech.
• Google Cloud API Design Guide - Best practices for designing APIs themselves.
• Redocly Docs-as-Code Guide - Workflows for modern documentation teams.

Books

• Docs for Developers - Engineer-focused guide to technical documentation.

Ecosystem & Services

Agencies and partners specializing in Developer Experience.

Agency	Specialization	Website
Reclear	Technical content, engineering blogs, and API documentation	reclear.io
Draft.dev	Technical Content & Engineering Blogs	draft.dev
EveryDeveloper	Developer Personas & DX Audits	everydeveloper.com

Contributing

See contributing.md.