Design and document robust APIs with clear endpoints, fostering developer collaboration and scalability.

1.0

ANTHROPIC: CLAUDE 3.5 SONNET

Project: Purpose, Project: Features / Advantages, Project: Target Audience, Project: Tech Stack, Jira issue (full context)

• Input: Jira issue description and project goals

• AI Task: Extract requirements for the API:

  • Identify endpoints, data flows, and functionalities.

  • Highlight constraints (e.g., performance, security).

• Output: A structured table of API requirements.

• Input: API requirements and data flow context

• AI Task: Define the endpoints for the API:

  • Include HTTP methods (GET, POST, PUT, DELETE, etc.).

  • Specify request/response structures (e.g., headers, body, query params).

• Output: A structured table of API endpoints.

• Input: API design and endpoint details

• AI Task: Create developer-friendly API documentation:

  • Include endpoint descriptions, examples, and error handling.

  • Suggest tools like Swagger/OpenAPI for documentation generation.

• Output: A detailed API documentation draft.

• Input: Full API design, endpoints, and documentation

• AI Task: Review the API design for completeness:

  • Identify gaps or inconsistencies in endpoint definitions.

  • Suggest improvements for scalability or security.

• Output: A validation report with actionable feedback.