api-designer
/api-designer
Projektuje architekturę API i dokumentację w OpenAPI dla usług REST, GraphQL i gRPC, z wersjonowaniem i uwierzytelnianiem.
- Autor
- JochenYang ↗
- Repozytorium
- Jochen-ai-rules ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 28.07.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 6
- Skrypty
- 1
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 28.07.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
- 1 skrypt w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.
Skrypty: scripts/openapi-gen.sh
Co robi i kiedy
Projektuje architekturę API i dokumentację w OpenAPI dla usług REST, GraphQL i gRPC, z wersjonowaniem i uwierzytelnianiem.
Oryginalny opis (EN)
API architecture design and documentation for RESTful, GraphQL, and gRPC services. Creates OpenAPI specifications, defines versioning strategies, and establishes authentication/authorization patterns. Use when user asks to design API, create endpoints, document REST/GraphQL, or plan API architecture.
Jak działa
- Core Capabilities
- Quick Reference
- Design Principles
- Boundaries
- When NOT to Use
- When To Use
- Detailed References
- Escalation Rules
- Final Output Contract (MANDATORY)
Podgląd SKILL.md
--- name: api-designer description: API architecture design and documentation for RESTful, GraphQL, and gRPC services. Creates OpenAPI specifications, defines versioning strategies, and establishes authentication/authorization patterns. Use when user asks to design API, create endpoints, document REST/GraphQL, or plan API architecture. --- # API Designer Design high-quality API interfaces and output standardized interface documentation and design specifications. ## Core Capabilities - RESTful/GraphQL/gRPC architecture design - Unified naming conventions and error handling - OpenAPI/Swagger documentation generation - API versioning and backward compatibility - Authentication, authorization, and rate limiting strategies ## Quick Reference ### HTTP Method Semantics | Method | Purpose | Idempotent | |--------|-----------------|------------| | GET | Read resource | ✅ | | POST | Create resource | ❌ | | PUT | Full update | ✅ | | PATCH | Partial update | ❌ | | DELETE | Delete resource | ✅ | ### Common Status Codes - `200` Success / `201` Created / `204` No Content - `400` Bad Request / `401` Unauthorized / `403` Forbidden / `404` Not Found - `500` Server Error ## Design Principles 1. **Resource-Oriented**: Use plural nouns in URLs, express actions with HTTP methods 2. **Unified Format**: Consistent request/response format, structured error messages 3. **Version Management**: URL or Header version control, backward compatibility 4. **Security First**: Authentication, authorization, input validation, rate limiting ## Boundaries Focus on API design and documentation standards, not specific business logic implementation. ## When NOT to Use - Writing implementation code → use `developer` - Database schema design → use `database-engineer` - Frontend UI development → use `frontend-design` - Infrastructure or DevOps setup → use `devops-engineer` ## When To Use Use this skill when the user asks to: - design a new API or endpoint structure - document existing APIs with OpenAPI/Swagger - plan API versioning or migration strategy - establish authentication/authorization patterns for APIs ## Quick Reference **Always run `--help` first** to see usage. - `scripts/openapi-gen.sh` - Generate OpenAPI documentation ## Detailed References - `./workflows/api-design.md` - API design workflow - `./guides/rest-api.md` - REST API design guide - `./guides/graphql.md` - GraphQL API design guide - `./guides/grpc.md` - gRPC API design guide ## Escalation Rules Pause and ask the owner before: - locking in an API style, auth model, or versioning strategy that has broad product impact - expanding from interface design into implementation details outside this skill's boundary - making compatibility assumptions that could break existing clients ## Final Output Contract (MANDATORY) Every use of this skill should end with: 1. `Skill Fit` - why API design work was needed 2. `Primary Deliverable` - interface design, spec, or contract summary 3. `Execution Evidence` - references used, files produced, and validation performed 4. `Risks / Open Questions` - compatibility, auth, or rollout concerns 5. `Next Action` - the concrete documentation, review, or implementation step
Pliki w paczce (6)
- SKILL.md 3 KB
- guides/graphql.md 3 KB
- guides/grpc.md 3 KB
- guides/rest-api.md 3 KB
- scripts/openapi-gen.sh 4 KB
- workflows/api-design.md 4 KB
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · JochenYang/Jochen-ai-rules | 90 | MIT |
| Jeffallan/claude-skills | 100 | MIT |
| nguyenthienthanh/aura-frog | 100 | MIT |
| agentic-swe/agentic-swe | 100 | MIT |
| LambdaTest/agent-skills | 100 | MIT |
| nasac0x/code-orchestrator | 100 | MIT |
| wyattowalsh/agents | 100 | MIT |
| wesleyegberto/software-engineering-skills | 100 | MIT |
| zhaono1/agent-playbook | 100 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki e563133ab6f3 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100api-design
Pomaga projektować API REST, GraphQL, gRPC i WebSocket z nazewnictwem zasobów, wersjonowaniem, paginacją, obsługą błędów i wzorcami bramek API. - 100api-design
Podaje dobre praktyki projektowania API REST, GraphQL i gRPC: kontrakty, wersjonowanie, OpenAPI 3.2, GraphQL Federation i strumieniowanie gRPC. - 100api-design
Projektuje kontrakty REST, GraphQL i OpenAPI przed implementacją w podejściu API-first. - 100api-design
Projektuje produkcyjne API REST, GraphQL, gRPC i biblioteczne w Pythonie z poprawnymi schematami, kontraktami błędów, uwierzytelnianiem i wersjonowaniem. - 100api-design-ops
Podaje wzorce projektowania API dla REST, gRPC i GraphQL: protobuf, schematy, wersjonowanie, paginacja, limity, format błędów, OpenAPI, JWT, OAuth2 i bramki. - 90api-contract-design
Podpowiada wzorce projektowania API REST i GraphQL, specyfikacje OpenAPI/Swagger, strategie wersjonowania i uwierzytelniania.