skills.rest
CenredJun
CenredJunCOMMUNITY
Explore all skills by this author →
GitHub

api-architect

Design REST, GraphQL, and gRPC API contracts with OpenAPI 3.1, proto3, and OAuth/JWT security.

Updated Mar 27, 2026
Search Tags:#security#api#openapi#graphql#rate-limiting#grpc#api-design
One-click install
npx skills add https://github.com/CenredJun/openclaw-claudecode-setup-kit --skill api-architect-cenredjun
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-architect
Source: https://github.com/CenredJun/openclaw-claudecode-setup-kit/tree/main/skills/api-architect
Command: npx skills add https://github.com/CenredJun/openclaw-claudecode-setup-kit --skill api-architect-cenredjun

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Helps teams and engineers design consistent, versioned, and secure APIs across REST, GraphQL, and gRPC, reducing ambiguous contracts, preventing common anti-patterns, and producing machine-readable specifications and implementation artifacts.

Core Features & Use Cases

  • API-first design: Produce OpenAPI 3.1 specs for REST, SDL schemas for GraphQL, and .proto definitions for gRPC with clear operationIds and pagination patterns.
  • Security & governance: Recommend OAuth/JWT, API key handling, CORS, security headers, and audit logging to harden APIs.
  • Quality & validation: Provide linting and validation via a validation script, rate limiting guidance, idempotency and error envelope standards, and SDK generation readiness.
  • Use case: Create a production-ready user service that includes OpenAPI documentation, Relay-style GraphQL connections for client apps, proto3 streaming patterns for backend services, and a rate-limiting policy for different tiers.

Quick Start

Ask the api-architect to generate an OpenAPI 3.1 specification for a user-management REST API with JWT authentication, cursor pagination, consistent error envelopes, and rate limiting.

Frequently Asked Questions about api-architect

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

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

You generate an OpenAPI 3.1 specification with JWT authentication and cursor pagination by defining REST endpoints, applying OAuth/JWT security schemes, and implementing cursor-based pagination patterns to ensure SDK generation readiness and consistent API contracts.

What is the best way to design GraphQL schemas with Relay patterns for client applications?▼

The best way to design GraphQL schemas with Relay patterns is to create SDL schemas implementing standardized connection structures for pagination, ensuring consistent data fetching, efficient querying, and structured error envelopes for client applications.

How do I define proto3 gRPC services with streaming patterns?▼

To define proto3 gRPC services with streaming patterns, you write .proto definitions specifying service methods and message types, enabling efficient backend service communication through unary and streaming RPC calls with clear operationIds.

How do I implement rate limiting policies and idempotency support for public APIs?▼

You implement rate limiting policies and idempotency support for public APIs by defining tiered rate-limiting rules and incorporating idempotency keys within your API design, preventing abuse and ensuring reliable retry mechanisms.

Can I use this API design approach for both internal and public APIs?▼

Yes, you can use this API design approach for both internal and public APIs, as it recommends OAuth/JWT, API key handling, CORS, security headers, and audit logging to harden APIs and ensure robust security governance across different exposure levels.

Why do I need operationIds in my OpenAPI and gRPC definitions?▼

You need operationIds in OpenAPI and gRPC definitions to ensure SDK generation readiness, as clear operationIds provide unique method identifiers for client libraries, enabling automated code generation and reducing ambiguous API contracts.

Related Skills

Explore More Software Engineering Skills→
diShine-digital-agencydiShine-digital-agency
1

shine-api-design

Generate OpenAPI 3.1 skeletons or GraphQL SDL for a given domain.

Community
Intermediate
erichowenserichowens
181

api-architect

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

Community
Advanced
AGIBuildAGIBuild
10

dotnet-api-security

Implement authentication, authorization, and threat mitigation for ASP.NET Core Web APIs.

Community
Advanced
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced