Apiary
Apiary is an API design and documentation platform, now part of Oracle Cloud Infrastructure. With 486,000+ users and 591,000+ APIs managed, it uses API Blueprint and Swagger/OpenAPI specifications to produce interactive API documentation, mock servers, automated testing, and collaborative API design workflows. Apiary enables teams to design APIs before writing code, generate documentation automatically, and validate implementations against specifications.
APIs
Apiary API
The Apiary API provides programmatic access to manage API projects, documentation, and team collaboration. It allows creating and updating API Blueprint and Swagger/OpenAPI docu...
API Blueprint
API Blueprint is a high-level API design language created by Apiary for designing and documenting web APIs. It uses a Markdown-based syntax that is human-readable and machine-pa...
Features
Native support for API Blueprint, a high-level Markdown-based API description language for collaborative design.
Import and work with Swagger and OpenAPI specifications alongside API Blueprint documents.
Auto-generate interactive documentation from API specs with a built-in API console for live testing.
Instant mock servers generated from API specs allowing frontend development before backend is ready.
Run automated tests against API implementations using Dredd, the open-source API testing framework.
Team-based API design with version history, commenting, and shared workspaces.
Apiary CLI for integrating API design and testing workflows into CI/CD pipelines.
Maintains Dredd (testing), Gavel (validation), and API Blueprint as open-source projects.
Use Cases
Design APIs in API Blueprint or OpenAPI before writing code, enabling parallel frontend and backend development.
Automatically generate interactive API documentation from API specifications for developer consumption.
Generate instant mock servers from specs to enable frontend development without a live backend.
Validate API implementations against their specifications using Dredd to catch regressions.
Collaborate on API design standards and review API changes in a shared workspace.