API Design Review Walkthrough

Review this API design step by step.

API specification:
{{api_spec}}

Use case: {{use_case}}
Consumers: {{api_consumers}}

Think through each principle:

1. NAMING: Are resource names intuitive and consistent?

2. HTTP METHODS: Are methods semantically correct? (GET for reads, POST for creates)

3. STATUS CODES: Are status codes accurate and helpful?

4. REQUEST DESIGN: Are request bodies minimal and well-structured?

5. RESPONSE DESIGN: Are responses complete? Is there over-fetching?

6. PAGINATION: How is pagination handled? Is it consistent?

7. FILTERING/SORTING: Are query parameters logical and documented?

8. ERROR HANDLING: Are errors informative and actionable?

9. VERSIONING: Is the versioning strategy clear and sustainable?

10. SECURITY: Are auth, rate limits, and validation addressed?

11. DOCUMENTATION: Is the API self-documenting?