Skill

api-design

RESTful API design with OpenAPI specs, validation, and documentation generation. Use when user says "design API", "API design", or "create endpoint".

Install

npx claudepluginhub monty1985/adams-mind --plugin dev-api-design

Tool Access

This skill uses the workspace's default tool permissions.

Preview

- Identify the core resources and their relationships

SKILL.md

Similar Skills

context7-mcp

Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.

context7-plugin

51.8k

find-docs

Retrieves current documentation, API references, and code examples for libraries, frameworks, SDKs, CLIs, and services via Context7 CLI. Ideal for API syntax, configs, migrations, and setup queries.

context7

50.8k

context7-cli

3 files

Uses ctx7 CLI to fetch current library docs, manage AI coding skills (install/search/generate), and configure Context7 MCP for AI editors.

context7

50.8k

Stats

Parent Repo Stars0

Parent Repo Forks0

Last CommitApr 1, 2026

Actions

View Source View Plugin View on GitHub View README

API Design

Phase 1: Resource Modeling

Identify the core resources and their relationships

Define resource names using nouns (not verbs) in plural form

Map out the data model for each resource (fields, types, constraints)

Determine ownership and access control requirements

Phase 2: Endpoint Design

Define CRUD endpoints using standard HTTP methods (GET, POST, PUT, PATCH, DELETE)

Design URL structure: /resources, /resources/:id, /resources/:id/sub-resources

Specify request and response schemas with clear field definitions

Define HTTP status codes for success and each error condition

Design pagination, filtering, and sorting for list endpoints

Plan versioning strategy (URL path /v1/ or header-based)

Phase 3: Documentation

Write an OpenAPI 3.x spec for all endpoints

Include example requests and responses for each endpoint

Document authentication requirements (Bearer token, API key, OAuth)

List error codes with descriptions and recovery guidance

Publish docs to an internal developer portal or Swagger UI

API Design

Phase 1: Resource Modeling

Identify the core resources and their relationships
Define resource names using nouns (not verbs) in plural form
Map out the data model for each resource (fields, types, constraints)
Determine ownership and access control requirements

Phase 2: Endpoint Design

Define CRUD endpoints using standard HTTP methods (GET, POST, PUT, PATCH, DELETE)
Design URL structure: /resources, /resources/:id, /resources/:id/sub-resources
Specify request and response schemas with clear field definitions
Define HTTP status codes for success and each error condition
Design pagination, filtering, and sorting for list endpoints
Plan versioning strategy (URL path /v1/ or header-based)

Phase 3: Documentation

Write an OpenAPI 3.x spec for all endpoints
Include example requests and responses for each endpoint
Document authentication requirements (Bearer token, API key, OAuth)
List error codes with descriptions and recovery guidance
Publish docs to an internal developer portal or Swagger UI