openapi-standards

What problem does it solve?

OpenAPI standards and guidelines to ensure consistent, high-quality API specifications across teams.

Core Features & Use Cases

• Standard operation naming conventions (get{Resource}, list{Resources}, create{Resource}, update{Resource}, delete{Resource})
• Mandatory descriptive documentation and vendor guidance; structured descriptions derived from vendor docs
• Schema organization and naming patterns to maintain clarity and reuse
• Parameter naming to avoid conflicts with operation-specific qualifiers
• Enum descriptions via x-enum-descriptions and metadata guidance for all enum values
• Security and metadata configuration guidance, including OAuth2-based security schemes

Quick Start

Apply these guidelines to your API specs to ensure consistent naming, complete documentation, and secure configuration.