skills.rest
JochenYang
JochenYangCOMMUNITY
Explore all skills by this author →
GitHub

api-designer

Design REST, GraphQL, and gRPC APIs with OpenAPI generation and versioning strategies.

21|3|Updated Jan 22, 2026
Search Tags:#design#documentation#API#security#GraphQL#REST#OpenAPI
One-click install
npx skills add https://github.com/JochenYang/Jochen-ai-rules --skill api-designer-jochenyang
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/JochenYang/Jochen-ai-rules/tree/main/.claude/skills/api-designer
Command: npx skills add https://github.com/JochenYang/Jochen-ai-rules --skill api-designer-jochenyang

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires tsoa, swagger-jsdoc, and includes scripts (resource) components.

What problem does it solve?

This Skill helps API teams design and document robust interfaces across REST, GraphQL, and gRPC, ensuring consistency and speed from design to deployment.

Core Features & Use Cases

  • Unified API design guidance for REST, GraphQL, and gRPC
  • OpenAPI specification generation and versioning strategies
  • Security patterns (authentication/authorization) and naming conventions
  • Use Case: A fintech service defines a stable API surface and docs for a new microservice.

Quick Start

Use the api-designer skill to scaffold an OpenAPI doc for a new service and validate the design.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design and document robust REST and GraphQL APIs?▼

To design and document robust APIs, you need unified guidance for REST, GraphQL, and gRPC services that enforces resource-oriented design, consistent error handling, and backward compatibility while generating OpenAPI specifications.

What is the best way to generate an OpenAPI specification for a new microservice?▼

Generating an OpenAPI specification is best handled by scaffolding the design first, validating resource-oriented patterns, and applying consistent versioning strategies and secure authentication patterns to produce stable implementation references.

Can I use tsoa and swagger-jsdoc to scaffold OpenAPI docs for multiple API paradigms?▼

Yes, you can leverage tsoa and swagger-jsdoc dependencies to scaffold and validate OpenAPI documents, ensuring your design covers secure authentication patterns across REST, GraphQL, and gRPC paradigms.

How do I enforce backward compatibility and consistent error handling in API design?▼

To enforce backward compatibility and consistent error handling in API design, apply resource-oriented design principles and structured versioning strategies that produce clear design references and implementation guidance.

What security patterns should I use for authentication and authorization in GraphQL?▼

Security patterns for authentication and authorization in GraphQL should enforce secure access controls alongside naming conventions, ensuring consistent application across multiple API paradigms including REST and gRPC.

Related Skills

Explore More Software Engineering Skills→
manastalukdarmanastalukdar
1

types-generate

Generate TypeScript types from JSON schemas, OpenAPI, GraphQL, and database definitions.

Community
Advanced
Dokkabei97Dokkabei97
2

api-first-design

Design API contracts with OpenAPI and GraphQL schemas.

Community
Intermediate
0xtaoist0xtaoist

ln-775-api-docs-generator

Generate Swagger/OpenAPI documentation for .NET and Python APIs.

Community
Advanced
erichowenserichowens
181

api-architect

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

Community
Advanced