本文へスキップ
Kitbay
スキル

api-design-principles

MIT2026年11月9日 更新42,406GitHubスター

A skill from Seth Hobson's agents collection, in its backend-development plugin, with principles for designing REST and GraphQL APIs and for reviewing API specifications or setting team standards.

スキルの内容

A skill from Seth Hobson's agents collection, in its backend-development plugin, with principles for designing REST and GraphQL APIs and for reviewing API specifications or setting team standards. For REST it covers resource-oriented URLs, HTTP method meaning, which methods are safe or idempotent, status codes and statelessness. For GraphQL it covers schema-first design, queries, mutations and subscriptions, cursor pagination in the Relay style and structured errors in mutation results. It compares three ways of versioning, and adds rate limiting, OpenAPI documentation, batching loaders to avoid repeated queries, deprecation and query complexity limits. Common mistakes include breaking changes, inconsistent errors and tying the API to the database schema.

できること

  • Design resource-oriented REST endpoints
  • Design GraphQL schemas with cursor pagination
  • Choose an API versioning strategy
  • Review an API specification for common mistakes