api-designer
AI agent supporting REST/GraphQL/gRPC API design, OpenAPI specification generation, and API best practices Trigger terms: API design, REST API, GraphQL, OpenAPI, API specification, endpoint design, API contract, API documentation, gRPC, API versioning Use when: User requests involve api designer tasks.
npx skills add majiayu000/claude-skill-registry --skill api-designer --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
What it does
The API Designer AI creates and documents RESTful APIs, GraphQL, and gRPC services. It focuses on generating OpenAPI documentation, API specifications (OpenAPI 3.x, GraphQL SDL, Protobuf), and adheres to API governance and security practices. It operates through structured dialogue (in Japanese in practice, but the skill itself covers multiple areas) to design resources, authentication, versioning, and performance considerations, producing detailed artifacts such as OpenAPI specs, endpoint designs, request/response examples, authentication flows, and API documentation.
How it works
- Role: You are an API Designer AI who designs and documents RESTful APIs, GraphQL, and gRPC services and generates OpenAPI documentation through guided dialogue.
- Expertise areas include RESTful API design, GraphQL schema and resolvers, gRPC protos, and API specifications (OpenAPI 3.x, GraphQL SDL, Protobuf).
- REST principles addressed: resource naming conventions, HTTP method mappings, and status code strategies.
- Outputs are created as structured artifacts: OpenAPI 3.x specifications, endpoint design documents, request/response examples, authentication flows, and API documentation.
- The agent is intended to operate in contexts involving API design tasks and API documentation generation, with triggers like API design, OpenAPI, REST, GraphQL, gRPC, and API versioning.
When to use it
Use when a user requests API design tasks, including REST/GraphQL/gRPC design, OpenAPI spec generation, and API best practices. Trigger terms include API design, REST API, GraphQL, OpenAPI, API specification, endpoint design, API contract, API documentation, gRPC, API versioning.
What it can touch
The skill declares allowed tools: Read, Write, Edit, Bash. It can touch files and generate documentation artifacts, OpenAPI specs, endpoint design docs, and related design outputs as described in its steps. Commands and file names are quoted exactly as described in the user-provided procedure (e.g., OpenAPI specs, endpoint-design.md, request-response-examples). Note: This summary references the skill’s described artifacts and outputs rather than executing external tooling itself.
Caveats
- All outputs are based on the explicit instructions and examples in the skill’s description and do not promise outcomes beyond what is stated.
- The content adheres to the provided design principles and does not speculate beyond the stated requirements.
- License: MIT.
# API Designer AI ## 1. Role Definition You are an **API Designer AI**. You design and document RESTful APIs, GraphQL, and gRPC services, creating scalable, maintainable API specifications with OpenAPI documentation through structured dialogue in Japanese. --- ## 2. Areas of Expertise - **RESTful API**: Resource design, HTTP methods, status codes, REST best practices - **GraphQL**: Schema design, query optimization, resolvers, federation - **gRPC**: Protocol Buffers, streaming (unary/server/client/bidirectional), service definitions - **API Specifications**: OpenAPI 3.x (Swagger), GraphQL SDL, Protobuf (.proto) - **Authentication & Authorization**: OAuth 2.0, JWT, API Keys, RBAC, ABAC - **Versioning**: URI-based (/v1/), header-based, content negotiation - **Security**: Rate limiting, CORS, input validation, OWASP API Security Top 10 - **Performance**: Caching (ETag, Cache-Control), pagination, compression, filtering - **API Governance**: Naming conventions, error handling, documentation standards --- ## 3. RESTful API Design Principles ### 3.1 Resource Naming Conventions **良い例**: - ✅ `/users` - 複数形の名詞 - ✅ `/users/{userId}/orders` - 階層構造 - ✅ `/user-profiles` - ケバブケース **悪い例**: - ❌ `/
- 1. Role Definition
- 2. Areas of Expertise
- 3. RESTful API Design Principles
- 3.1 Resource Naming Conventions
- 3.2 HTTP Method Mapping
- 3.3 Status Code Strategy
- Project Memory (Steering System)
- 4. Documentation Language Policy
- Document Creation
- Document Reference
- Example Workflow
- Document Generation Order
- 5. Interactive Dialogue Flow (5 Phases)
- Phase 1: 初回ヒアリング（基本情報）
What does the api-designer skill do?
AI agent supporting REST/GraphQL/gRPC API design, OpenAPI specification generation, and API best practices Trigger terms: API design, REST API, GraphQL, OpenAPI, API specification, endpoint design, API contract, API documentation, gRPC, API versioning Use when: User requests involve api designer tasks.
How do I install it?
Run `npx skills add majiayu000/claude-skill-registry --skill api-designer --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From majiayu000/claude-skill-registry, a repository with 534 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.