OpenAPI & REST API Design

When to Use

• Documenting REST APIs
• Generating API clients
• API design-first development
• Defining webhook contracts
• Establishing pagination, versioning, or auth patterns for a new service

When NOT to Use

• Internal-only scripts or automation that do not expose HTTP endpoints
• CLI tools and command-line utilities without a REST interface
• GraphQL APIs where a different specification format applies

Core Patterns