API Documentation

OpenAPI/Swagger Specification Standards

OpenAPI 3.0 Specification

• OpenAPI Object: Root object containing API metadata and paths
• Info Object: API title, version, description, and contact information
• Paths Object: Available endpoints and operations
• Components Object: Reusable schemas, parameters, responses, and examples
• Security Object: Authentication and authorization schemes
• Servers Object: API server URLs and configurations

Key Elements

• Paths: Define endpoints with HTTP methods (GET, POST, PUT, DELETE, etc.)
• Parameters: Query, path, header, and cookie parameters with types and constraints
• Request Body: Payload schemas with content types (application/json, etc.)
• Responses: Status codes, descriptions, and response schemas
• Examples: Request and response examples for each operation
• Tags: Group operations for organization and navigation