Resources
OpenAPI Hub
The all in one resource for understanding the OpenAPI Specification.
OpenAPI Basics
Start with these foundational concepts to understand and create OpenAPI specifications.
Servers
Defining the servers where your API is available.
Paths & Operations
Defining API endpoints and their HTTP operations.
Tags
Organizing and categorizing API operations.
Schemas
Defining data models and structures for requests and responses.
Parameters
Defining path, query, header, and cookie parameters for operations.
Requests
Handling request parameters, headers, and body content.
Responses
Defining response formats, status codes, and error handling.
Security
Implementing authentication and authorization schemes.
Advanced Considerations
Once you’ve mastered the basics, explore these advanced topics for more sophisticated API documentation.
Components
Reusable schemas, parameters, and other OpenAPI elements.
References
Linking to external schemas and splitting large specifications.
Webhooks
Documenting outbound API calls and event notifications.
Extensions
Adding custom functionality with OpenAPI extensions.
Code Examples
Providing code samples and usage examples.
Overlays
Extending OpenAPI documents without modifying the original spec.
OpenAPI Parser Library
Work directly with OpenAPI specifications, Arazzo workflows, and OpenAPI Overlays using our comprehensive Go library and CLI tools.
speakeasy-api/openapi
Battle-tested Go library for parsing, validating, and manipulating OpenAPI 3.0/3.1 specifications, Arazzo workflow documents, and OpenAPI Overlays. Includes a comprehensive CLI for common operations.
Key features:
- • Full OpenAPI 3.0.x and 3.1.x support with validation
- • Arazzo workflow document parsing and validation
- • OpenAPI Overlay application and comparison
- • Document traversal and manipulation APIs
- • Reference resolution with circular reference handling
CLI installation:
go install github.com/speakeasy-api/openapi/cmd/openapi@latest
# Additional installation options coming soonServer Framework Guides
Generate OpenAPI specs from popular server frameworks:
NestJS
TypeScript API framework
tRPC
End-to-end type-safe APIs
Hono
Ultrafast web framework
Fastify
Low overhead framework
tsoa
TypeScript OpenAPI generator
Zod
TypeScript schema validation library
FastAPI
Modern API framework with auto docs
Flask
Lightweight and flexible
Django
Full-featured web framework
Goa
Design-first microservices
Spring Boot
Enterprise-grade framework
Laravel
Elegant web framework
Ruby on Rails
OpenAPI 3.0 & Swagger for Rails
Gnostic
OpenAPI to gRPC compiler
gRPC Gateway
RESTful proxy for gRPC
Last updated on