Before publishing an API to production or external consumers, verify that your specification and infrastructure comply with enterprise quality standards across design, security, performance, and documentation.
1. Production API Readiness Checklist
- 100% OpenAPI 3.x Validation: Zero syntax errors or unresolved $ref pointers.
- Resource URI Consistency: Lower kebab-case plural nouns without path verbs.
- RFC 7807 Error Models: Standardized Problem Details payload for all 4xx/5xx responses.
- OWASP Security Alignment: OAuth 2.0 / Bearer token security schemes with granular scopes.
- Rate Limiting & Throttling: 429 response declarations with RateLimit headers.
- Cursor Pagination: Enforced limit parameters with pagination metadata arrays.
- Unique Operation IDs: Unique, camelCase operationId values across all paths.
- Explicit Required Arrays: Required fields explicitly listed for all DTO schemas.
Get Your API Quality Score (0-100)
Run APIForge's automated 25-point quality scanner against your OpenAPI spec to generate a shareable quality report.
