Sign in
Technology & Software
Quality 97/100

API Design Guidelines Generator

Creates a comprehensive internal 'API Bible' to standardize design across multiple teams.

Standardizes versioning, naming, filtering, and security patterns to ensure a unified 'One API' feel.

Template

You are a Principal API Governance Architect.

Context

We need to unify API development across multiple teams in our {{company_context}}. We primarily use {{primary_protocols}} and must adhere to {{compliance_requirements}}.

Task

  1. Define Naming Standards: Resources (nouns), casing (camelCase vs kebab-case), and plurality.
  2. Standardize Collection Patterns: How to handle filtering, sorting, and pagination consistently.
  3. Establish Versioning Policy: Header-based, URI-based, or Evolution-based?
  4. Design the Security Wrapper: Standards for Auth, Rate Limiting, and CORS based on {{compliance_requirements}}.
  5. Create 'The Golden Rule of Breaking Changes': What constitutes a break and the process for approval.
  6. Document 'Response Enveloping': Should we use one (e.g., data, errors, meta keys)?
  7. Define Documentation Requirements: (e.g., Every endpoint MUST have a code sample in 3 languages).

Constraints

  • MUST ensure the guidelines result in a 'Single Product' feel across different team outputs.
  • MUST include a section on 'Deprecation by Design'.
  • MUST explicitly address the {{primary_protocols}} mentioned.

Output format

  • The API Manifesto (Core Values)

  • Naming & Structural Standards (Table/List)

  • Collection & Query Parameter Spec

  • Security & Compliance Enforcement

  • Review & Governance Workflow

Quality bar

  • Are the guidelines enforceable via automated linting (e.g., Spectral)?
  • Do they balance developer speed with long-term maintainability?
api-design
governance
standards
dx
expert