- 📁 assets/
- 📁 references/
- 📄 SKILL.md
REST 및 GraphQL API 설계 원칙 가이드. 새로운 API 설계, API 스펙 리뷰, API 설계 표준 수립 시 활용. 트리거: "API 설계", "REST", "GraphQL", "엔드포인트 설계", "API versioning", "API 패턴" 안티-트리거: "프론트엔드 UI", "데이터베이스 스키마만", "CSS/스타일링", "배포/인프라"
- 📁 references/
- 📁 templates/
- 📄 SKILL.md
Use this skill when designing, documenting, or generating REST API specifications using OpenAPI/Swagger. Trigger on keywords like OpenAPI, Swagger, API spec, REST documentation, API schema, request body, response schema, and API client generation. Also apply when adopting design-first API development, validating API contracts, or setting up auto-generated API documentation for FastAPI, Express, or NestJS endpoints. --- # OpenAPI & REST API Design ## When to Use - Documenting REST APIs - Generating API clients - API design-first development - Defining webhook contracts - Establishing pagination, versioning, or auth patterns for a new service ## When NOT to Use - Internal-only scripts or automation that do not expose HTTP endpoints - CLI tools and command-line utilities without a REST interface - GraphQL APIs where a different specification format applies --- ## Core Patterns ### 1. OpenAPI 3.1 Specification Structure A complete spec skeleton showing every top-level section. Use `$ref` to split large specs into per-resource files. ```yaml
- 📁 .claude-plugin/
- 📁 scripts/
- 📄 SKILL.md
Clerk backend REST API
Используй MCP сервер Bitrix24 для поиска методов REST API, параметров и примеров; при отсутствии предложи подключение.
REST API design best practices covering versioning, error handling, pagination, and OpenAPI documentation. Use when designing or implementing REST APIs or HTTP endpoints. TRIGGER when: API design, REST endpoint, HTTP route, OpenAPI, swagger, pagination. DO NOT TRIGGER when: internal library code, CLI tools, non-HTTP interfaces.
Build production-ready REST APIs with versioning, documentation, and rate limiting. Use when the user wants to create API endpoints, build a REST API, add API resources, or generate OpenAPI documentation. Triggers: "build api", "create endpoint", "api resource", "rest api", "api documentation", "swagger", "json api", "graphql".