api-design

name	api-design
version	1.0.0
description	Design REST/GraphQL APIs
triggers	["api","endpoint","route","interface","design api"]
category	code
quality_bar	API is well-designed, documented, and follows best practices

API Design

Design and document APIs.

When to Trigger

• User asks to design an API
• Creating new endpoints
• Improving existing API

Steps

1. Understand requirements - What should the API do?
2. Design endpoints - Define routes and methods
3. Define schemas - Specify request/response formats
4. Document - Write OpenAPI/Swagger specs
5. Implement - Write the API code

Quality Bar

• RESTful conventions followed
• Clear endpoint naming
• Proper HTTP methods used
• Response codes appropriate
• Documentation complete

Tools Required

• write_file
• api documentation tools