Last Updated: November 21, 2025
Swagger/OpenAPI
API documentation standard
Core Concepts
| Item | Description |
|---|---|
OpenAPI Spec
|
YAML/JSON API definition |
Swagger UI
|
Interactive API docs |
Swagger Editor
|
Design APIs |
Swagger Codegen
|
Generate client SDKs |
Paths
|
API endpoints |
Schemas
|
Data models |
Basic Structure
| Item | Description |
|---|---|
openapi: 3.0.0
|
Specification version |
info
|
API metadata |
servers
|
API base URLs |
paths
|
Endpoints |
components
|
Reusable schemas |
security
|
Auth schemes |
Best Practices
- Use $ref for reusable components
- Add examples to schemas
- Document all response codes
- Use tags to organize endpoints
💡 Pro Tips
Quick Reference
OpenAPI is the industry standard for REST APIs