skills.rest
selrai-company
selrai-companyOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-architect

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

Updated Aug 23, 2026
Search Tags:#design#security#api#openapi#graphql#rate-limiting#grpc
One-click install
npx skills add https://github.com/selrai-company/claude-workshop-kit --skill api-architect-selrai-company
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-architect
Source: https://github.com/selrai-company/claude-workshop-kit/tree/main/skills/api-architect
Command: npx skills add https://github.com/selrai-company/claude-workshop-kit --skill api-architect-selrai-company

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Helps teams and engineers design consistent, secure, and versioned APIs across REST, GraphQL, and gRPC to reduce integration errors, unclear contracts, and unstable client-server contracts.

Core Features & Use Cases

  • API-first contract design with OpenAPI 3.1, GraphQL SDL, and Protocol Buffer definitions to generate stubs and SDKs.
  • Security & rate limiting guidance including OAuth2/JWT patterns, CORS, and tiered rate limit configurations.
  • Validation & DX with a validator script, operationId checks, pagination and error-envelope recommendations for SDK generation and CI gating.
  • Use Case: Produce a production-ready OpenAPI spec for a user service with JWT auth, cursor pagination, operationIds for SDK generation, and rate-limiting headers for public APIs.

Quick Start

Design an OpenAPI 3.1 spec for a user-management REST API that uses JWT authentication, cursor pagination, and tiered rate limits.

Frequently Asked Questions about api-architect

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

FAQPage Schema
How do I design an OpenAPI 3.1 spec with JWT authentication and cursor pagination?▼

To design an OpenAPI 3.1 spec with JWT authentication, define security schemes and map cursor pagination parameters to produce a production-ready contract for SDK generation.

Can I generate GraphQL SDL schemas and gRPC proto definitions for API-first workflows?▼

Yes, you can generate GraphQL SDL schemas and gRPC .proto service definitions for API-first workflows to produce stable client-server contracts and SDK stubs.

What is the best way to enforce operationIds and rate-limiting headers in an API contract?▼

The best way to enforce operationIds and rate-limiting headers in an API contract is through validation scripts that gate CI checks and ensure proper SDK generation.

How do I validate API contracts for REST, GraphQL, and gRPC architectures?▼

Validate API contracts for REST, GraphQL, and gRPC architectures by running validation scripts that check operationIds, security schemes, and error envelopes to reduce integration errors.

Does API contract design include security and rate limiting guidance for public services?▼

API contract design includes security and rate limiting guidance for public services, enforcing OAuth2/JWT patterns, CORS, and tiered rate limit configurations within the specification.

Related Skills

Explore More Software Engineering Skills→
Eigo-Mt-FujiEigo-Mt-Fuji

api-designer

Generate OpenAPI, GraphQL SDL, and Protocol Buffer definitions for APIs.

Community
Advanced
arbazkhan971arbazkhan971
26

api

Design and validate OpenAPI 3.1 specifications for REST, GraphQL, and gRPC services.

Community
Advanced
truongnattruongnat

api-security-pro

Implement OAuth2, OIDC, rate limiting, and JWT hardening for API security.

Community
Advanced
p-o-ke-naep-o-ke-nae

api-design-principles

Design REST and GraphQL API structures with versioning, pagination, and error handling.

Community
Advanced