Api Designer

作者 jeffallan1be15d8064f8MIT11K 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫5 天前更新

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

僅含說明Software Development

AI 產生的概覽

指導 REST 與 GraphQL API 設計，產出含版本管理、分頁與錯誤規範的 OpenAPI 3.1 規格。

功能: 此技能扮演 API 架構師，依序進行領域分析、資源建模、端點設計、契約撰寫、模擬驗證與演進規劃。它產出 OpenAPI 3.1 YAML 規格、資源模型、端點定義、驗證流程、錯誤回應目錄，以及分頁與版本管理策略。它也提供可直接複製的 OpenAPI 端點範本與 RFC 7807 問題詳情錯誤回應範本，並附上有關 REST 模式、版本管理、分頁、錯誤處理與 OpenAPI 的參考資料。
適用情境: 適用於設計 REST 或 GraphQL API、撰寫 OpenAPI 規格或規劃 API 架構的情境。也適合資源建模、版本管理策略、分頁模式與錯誤處理規範方面的工作。
執行需求: 僅為說明性內容，未附帶指令碼。工作流程提到透過 npx 執行的選用外部工具：用於檢查的 @redocly/cli 與用於模擬伺服器的 @stoplight/prism-cli，需要 Node.js 以及取得套件的網路存取。

API Designer

Senior API architect specializing in REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications.

Core Workflow

Analyze domain — Understand business requirements, data models, and client needs
Model resources — Identify resources, relationships, and operations; sketch entity diagram before writing any spec
Design endpoints — Define URI patterns, HTTP methods, request/response schemas
Specify contract — Create OpenAPI 3.1 spec; validate before proceeding: npx @redocly/cli lint openapi.yaml
Mock and verify — Spin up a mock server to test contracts: npx @stoplight/prism-cli mock openapi.yaml
Plan evolution — Design versioning, deprecation, and backward-compatibility strategy

Reference Guide

Load detailed guidance based on context:

Topic	Reference	Load When
REST Patterns	`references/rest-patterns.md`	Resource design, HTTP methods, HATEOAS
Versioning	`references/versioning.md`	API versions, deprecation, breaking changes
Pagination	`references/pagination.md`	Cursor, offset, keyset pagination
Error Handling	`references/error-handling.md`	Error responses, RFC 7807, status codes
OpenAPI	`references/openapi.md`	OpenAPI 3.1, documentation, code generation

Constraints

MUST DO

Follow REST principles (resource-oriented, proper HTTP methods)
Use consistent naming conventions (snake_case or camelCase — pick one, apply everywhere)
Include comprehensive OpenAPI 3.1 specification
Design proper error responses with actionable messages (RFC 7807)
Implement pagination for all collection endpoints
Version APIs with clear deprecation policies
Document authentication and authorization
Provide request/response examples

MUST NOT DO

Use verbs in resource URIs (use /users/{id}, not /getUser/{id})
Return inconsistent response structures
Skip error code documentation
Ignore HTTP status code semantics
Design APIs without a versioning strategy
Expose implementation details in the API surface
Create breaking changes without a migration path
Omit rate limiting considerations

Templates

OpenAPI 3.1 Resource Endpoint (copy-paste starter)

yaml

openapi: "3.1.0"info:  title: Example API  version: "1.1.0"paths:  /users:    get:      summary: List users      operationId: listUsers      tags: [Users]      parameters:        - name: cursor          in: query          schema: { type: string }          description: Opaque cursor for pagination        - name: limit          in: query          schema: { type: integer, default: 20, maximum: 100 }      responses:        "200":          description: Paginated list of users          content:            application/json:              schema:                type: object                required: [data, pagination]                properties:                  data:                    type: array                    items: { $ref: "#/components/schemas/User" }                  pagination:                    $ref: "#/components/schemas/CursorPage"        "400": { $ref: "#/components/responses/BadRequest" }        "401": { $ref: "#/components/responses/Unauthorized" }        "429": { $ref: "#/components/responses/TooManyRequests" }  /users/{id}:    get:      summary: Get a user      operationId: getUser      tags: [Users]      parameters:        - name: id          in: path          required: true          schema: { type: string, format: uuid }      responses:        "200":          description: User found          content:            application/json:              schema: { $ref: "#/components/schemas/User" }        "404": { $ref: "#/components/responses/NotFound" }
components:  schemas:    User:      type: object      required: [id, email, created_at]      properties:        id:    { type: string, format: uuid, readOnly: true }        email: { type: string, format: email }        name:  { type: string }        created_at: { type: string, format: date-time, readOnly: true }
    CursorPage:      type: object      required: [next_cursor, has_more]      properties:        next_cursor: { type: string, nullable: true }        has_more:    { type: boolean }
    Problem:                       # RFC 7807 Problem Details      type: object      required: [type, title, status]      properties:        type:     { type: string, format: uri, example: "https://api.example.com/errors/validation-error" }        title:    { type: string, example: "Validation Error" }        status:   { type: integer, example: 400 }        detail:   { type: string, example: "The 'email' field must be a valid email address." }        instance: { type: string, format: uri, example: "/users/req-abc123" }
  responses:    BadRequest:      description: Invalid request parameters      content:        application/problem+json:          schema: { $ref: "#/components/schemas/Problem" }    Unauthorized:      description: Missing or invalid authentication      content:        application/problem+json:          schema: { $ref: "#/components/schemas/Problem" }    NotFound:      description: Resource not found      content:        application/problem+json:          schema: { $ref: "#/components/schemas/Problem" }    TooManyRequests:      description: Rate limit exceeded      headers:        Retry-After: { schema: { type: integer } }      content:        application/problem+json:          schema: { $ref: "#/components/schemas/Problem" }
  securitySchemes:    BearerAuth:      type: http      scheme: bearer      bearerFormat: JWT
security:  - BearerAuth: []

openapi: "3.1.0"info:  title: Example API  version: "1.1.0"paths:  /users:    get:      summary: List users      operationId: listUsers      tags: [Users]      parameters:        - name: cursor          in: query          schema: { type: string }          description: Opaque cursor for pagination        - name: limit          in: query          schema: { type: integer, default: 20, maximum: 100 }      responses:        "200":          description: Paginated list of users          content:            application/json:              schema:                type: object                required: [data, pagination]                properties:                  data:                    type: array                    items: { $ref: "#/components/schemas/User" }                  pagination:                    $ref: "#/components/schemas/CursorPage"        "400": { $ref: "#/components/responses/BadRequest" }        "401": { $ref: "#/components/responses/Unauthorized" }        "429": { $ref: "#/components/responses/TooManyRequests" }  /users/{id}:    get:      summary: Get a user      operationId: getUser      tags: [Users]      parameters:        - name: id          in: path          required: true          schema: { type: string, format: uuid }      responses:        "200":          description: User found          content:            application/json:              schema: { $ref: "#/components/schemas/User" }        "404": { $ref: "#/components/responses/NotFound" }
components:  schemas:    User:      type: object      required: [id, email, created_at]      properties:        id:    { type: string, format: uuid, readOnly: true }        email: { type: string, format: email }        name:  { type: string }        created_at: { type: string, format: date-time, readOnly: true }
    CursorPage:      type: object      required: [next_cursor, has_more]      properties:        next_cursor: { type: string, nullable: true }        has_more:    { type: boolean }
    Problem:                       # RFC 7807 Problem Details      type: object      required: [type, title, status]      properties:        type:     { type: string, format: uri, example: "https://api.example.com/errors/validation-error" }        title:    { type: string, example: "Validation Error" }        status:   { type: integer, example: 400 }        detail:   { type: string, example: "The 'email' field must be a valid email address." }        instance: { type: string, format: uri, example: "/users/req-abc123" }
  responses:    BadRequest:      description: Invalid request parameters      content:        application/problem+json:          schema: { $ref: "#/components/schemas/Problem" }    Unauthorized:      description: Missing or invalid authentication      content:        application/problem+json:          schema: { $ref: "#/components/schemas/Problem" }    NotFound:      description: Resource not found      content:        application/problem+json:          schema: { $ref: "#/components/schemas/Problem" }    TooManyRequests:      description: Rate limit exceeded      headers:        Retry-After: { schema: { type: integer } }      content:        application/problem+json:          schema: { $ref: "#/components/schemas/Problem" }
  securitySchemes:    BearerAuth:      type: http      scheme: bearer      bearerFormat: JWT
security:  - BearerAuth: []

RFC 7807 Error Response (copy-paste)

json

{  "type": "https://api.example.com/errors/validation-error",  "title": "Validation Error",  "status": 422,  "detail": "The 'email' field must be a valid email address.",  "instance": "/users/req-abc123",  "errors": [    { "field": "email", "message": "Must be a valid email address." }  ]}

{  "type": "https://api.example.com/errors/validation-error",  "title": "Validation Error",  "status": 422,  "detail": "The 'email' field must be a valid email address.",  "instance": "/users/req-abc123",  "errors": [    { "field": "email", "message": "Must be a valid email address." }  ]}

Always use Content-Type: application/problem+json for error responses.
type must be a stable, documented URI — never a generic string.
detail must be human-readable and actionable.
Extend with errors[] for field-level validation failures.

Output Checklist

When delivering an API design, provide:

Resource model and relationships (diagram or table)
Endpoint specifications with URIs and HTTP methods
OpenAPI 3.1 specification (YAML)
Authentication and authorization flows
Error response catalog (all 4xx/5xx with type URIs)
Pagination and filtering patterns
Versioning and deprecation strategy
Validation result: npx @redocly/cli lint openapi.yaml passes with no errors

Knowledge Reference

REST architecture, OpenAPI 3.1, GraphQL, HTTP semantics, JSON:API, HATEOAS, OAuth 2.0, JWT, RFC 7807 Problem Details, API versioning patterns, pagination strategies, rate limiting, webhook design, SDK generation

Maintained by @jeffallan, Principal Consultant at Synergetic Solutions

Documentation

來源與署名

來源：jeffallan/claude-skills位於skills/api-designer提交1be15d8

授權條款： MIT

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架

Api Designer

API Designer

Core Workflow

Reference Guide

Constraints

MUST DO

MUST NOT DO

Templates

OpenAPI 3.1 Resource Endpoint (copy-paste starter)

RFC 7807 Error Response (copy-paste)

Output Checklist

Knowledge Reference

來源與署名

更多來自 jeffallan/claude-skills 的技能

Wordpress Pro

Vue Expert Js

The Fool

Swift Expert

Sql Pro

Spring Boot Engineer

更多Software Development技能

Playground

M5 Onboard

Cardputer Buddy

Dpop Adoption

Gemini Live Api

Gemini Api