api-design

amattas 的头像作者 amattas

设计API端点、模式及合约。用于定义公共接口或数据模型时使用。

📖 中文导读:设计API端点、模式及合约。用于定义公共接口或数据模型时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: api-design description: Design API endpoints, schemas, and contracts. Use when defining public interfaces or data models.

API Design

Define the interface contracts for APIs, including endpoints, request/response schemas, and error handling.

Process

  1. Review spec.md and architecture.md
  2. Define endpoints and HTTP methods
  3. Design request and response schemas
  4. Define error responses and codes
  5. Consider versioning strategy

Output

Create api-design.md using the template in templates/api-design.md.

Tips

  • Use consistent naming conventions
  • Design for backwards compatibility
  • Include example payloads
  • Document rate limits if applicable
  • Consider pagination for list endpoints