api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

181|30|Updated Nov 16, 2025
One-click install
npx skills add https://github.com/erichowens/some_claude_skills --skill api-architect
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-architect
Source: https://github.com/erichowens/some_claude_skills/tree/main/.claude/skills/api-architect
Command: npx skills add https://github.com/erichowens/some_claude_skills --skill api-architect

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides expert API design guidance across REST, GraphQL, and gRPC, including OpenAPI, error handling, and versioning strategies.

Core Features & Use Cases

  • API Contract First: Design contracts before implementation.
  • Multi-Protocol Patterns: REST, GraphQL, gRPC, and WebSocket patterns.
  • Security & DX: Security schemas, documentation, and SDK generation.
  • Reference Files: Complete OpenAPI, GraphQL, and Protobuf examples in /references.

Quick Start

Start with an API contract, then pick a paradigm (REST/GraphQL/gRPC) and generate stubs.

Frequently Asked Questions about api-architect

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design REST APIs with OpenAPI and Swagger specifications?

REST API design with OpenAPI specs defines contracts before implementation. Use OpenAPI/Swagger to document endpoints, request/response schemas, authentication, and error codes. The Skill provides complete OpenAPI examples and validation patterns for consistent, versioned API contracts across teams.

What's the best way to structure GraphQL schemas and resolvers for scalable APIs?

GraphQL schema design balances query flexibility with performance and maintainability. Define clear types, implement pagination, handle errors uniformly, and apply security patterns. The Skill includes reference GraphQL schemas demonstrating anti-pattern remediation and idempotency strategies.

How do I implement rate limiting, CORS, and security headers in API design?

Security patterns in API architecture include rate limiting, CORS configuration, security headers, and input validation at the contract level. Design these into your API spec alongside authentication schemes and response envelopes to enforce consistency across REST, GraphQL, and gRPC endpoints.

Can I use gRPC with OpenAPI and REST in the same API architecture?

Multi-protocol API design supports REST, GraphQL, and gRPC alongside each other. The Skill covers patterns for consistent error handling, versioning, and response structures across protocols, including Protobuf examples and interop considerations for polyglot architectures.

What API versioning and error handling strategies prevent breaking changes?

API versioning and error handling strategies mitigate breaking changes through contract design. Define consistent response envelopes, status codes, and deprecation policies upfront. The Skill references OpenAPI and gRPC patterns for forward compatibility and clear error semantics.

How do I validate API contracts and generate SDK stubs from specifications?

API contract validation ensures consistency between spec and implementation. Generate SDKs and stubs from OpenAPI, GraphQL, and Protobuf definitions to maintain type safety and reduce manual work. The Skill includes validation tooling patterns and reference artifacts for all three paradigms.