api-design | Skill Performance & Reviews | TopRankSkills

TopRank Skills

Home / Skills / tools / api-design

api-design

maintained by amattas

star 1 account_tree 0 verified_user MIT License
bolt View GitHub

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

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!

Skill Details

GitHub Stars 1
GitHub Forks 0
Created Jan 2026
Last Updated 8 months ago
tools tools backend

Related Skills

nestjs-expert
chevron_right
api-routes
chevron_right
permissions
chevron_right
vespera
chevron_right
postman
chevron_right

Build your own?

Join 12,000+ developers contributing to the Claude ecosystem.