API Blueprint & Formats
API Blueprint syntax and how it compares to OpenAPI and Swagger, with copy-paste examples.
API Blueprint Media Types: Documenting Content-Type Negotiation
Content-type negotiation is one of the trickier parts of any REST API to document well. This guide covers every API Blueprint media type mechanic, from the plus-sign format modifier to vendor types, with copy-paste syntax you can drop into Apidoke today.
API Blueprint Named Examples and Data Structures: Advanced Patterns
Named examples and data structures let you define a response body once and reference it everywhere. This guide covers the full pattern with copy-paste API Blueprint syntax, real JSON bodies, and how Apidoke renders them in its live three-column viewer.
API Blueprint Include Directive: Splitting Large Blueprints Into Files
Large API Blueprint files become hard to maintain fast. The include directive lets you split one monolithic .apib file into focused, reusable modules, keeping your docs organized without sacrificing the single-file publishing experience.
API Blueprint Authentication Schemes: OAuth, API Keys, and Bearer Tokens
A precise, format-level guide to writing OAuth 2.0, API key, and Bearer token authentication schemes directly in API Blueprint files, with real syntax examples and Apidoke try-it console tips.
API Blueprint vs RAML: Which Format Fits Your Team?
API Blueprint and RAML are both human-readable API description formats, but they take very different approaches to structure and tooling. This guide breaks down the real differences so your team can choose confidently.
API Blueprint Action and Resource Model Explained
Resources and actions are the core building blocks of every API Blueprint document. This guide breaks down exactly how they work, how they nest, and how Apidoke turns them into a live, interactive reference.
Documenting Webhooks in API Blueprint
Webhooks push data to your users instead of waiting for them to ask. Documenting them clearly is just as important as documenting your REST endpoints, and API Blueprint gives you a clean, readable syntax for doing exactly that.
API Documentation Templates: Ready-to-Use API Blueprint Examples
Ready-to-use API Blueprint templates for the most common REST API patterns, with annotated examples you can paste directly into Apidoke and publish as live, interactive documentation.
API Blueprint Cheat-Sheet: Request and Response Bodies (Deep Dive)
A focused reference for modeling request and response bodies in API Blueprint, covering JSON payloads, headers, attributes, schema blocks, status codes, and how Apidoke renders each pattern live.
API Blueprint Syntax Cheat-Sheet
Every API Blueprint keyword, block, and pattern you need in one place. Copy-paste examples, real HTTP status codes, and notes on how each construct renders inside Apidoke.
API Blueprint and Formats: The Complete Category Hub
Your starting point for every API Blueprint and documentation format topic on Apidoke, from syntax basics to publishing a live try-it reference.
What Is API Blueprint? (Complete Guide)
API Blueprint is an open-source, Markdown-based format for describing REST APIs. This guide covers the syntax, real examples, how it compares to OpenAPI, and how Apidoke turns your Blueprint files into a live, interactive reference without any build toolchain.
Get API documentation tips in your inbox
New guides on API Blueprint, interactive docs, and developer experience, straight to your inbox. No spam, unsubscribe anytime.