Skip to content
Kitbay
Skill

api-design-principles

MITUpdated on Nov 10, 202649,466GitHub stars

A skill in the agentic-awesome-skills collection for designing and reviewing REST and GraphQL APIs so they are easy to use, scale and maintain.

What the skill teaches

A skill in the agentic-awesome-skills collection for designing and reviewing REST and GraphQL APIs so they are easy to use, scale and maintain. It applies to new APIs, refactoring existing ones, setting team standards, reviewing specs before they are built, moving between REST and GraphQL, writing developer documentation and shaping APIs for mobile or third-party clients, but not to framework-specific code or infrastructure work. The agent defines consumers and constraints, picks a style and models resources or types, specifies errors, versioning, pagination and authentication, and checks the design with examples. A playbook file holds the detailed patterns and checklists. Its metadata gives the source only as community.

Capabilities

  • Choose an API style and model resources
  • Specify errors, versioning and pagination
  • Review an API spec before implementation