dev-api-design
Build APIs across REST, GraphQL, gRPC, and tRPC styles with contract-first design, RFC 9457 error models, and modern best practices. Covers OpenAPI specs, versioning strategies, authentication/authorization, rate limiting, pagination, and observability patterns for public and internal services.
dev-api-design helps you architect production-grade APIs using REST, GraphQL, gRPC, or tRPC with proper contracts and patterns.
AI-generated summary based on this skill's SKILL.md
Decision gist · record as of 2026-07-13
dev-api-design helps you architect production-grade APIs using REST, GraphQL, gRPC, or tRPC with proper contracts and patterns. Build APIs across REST, GraphQL, gRPC, and tRPC styles with contract-first design, RFC 9457 error models, and modern best practices. Covers OpenAPI specs, versioning strategies, authentication/authorization, rate limiting, pagination, and observability patterns for public and internal services.
Use it when
- dev-api-design helps you evaluate each style: REST for simple CRUD and public APIs.
- dev-api-design covers versioning approaches including URL paths, headers, and content negotiation.
Verify before relying
Read SKILL.md below before installing (26 files). Open directory: indexed for reading, not audited.
Similar skills
Install
vasilyu1983/AI-Agents-public/dev-api-design · repository language: Python
Open directory. Skills are indexed for reading, not audited. Review a skill's body before installing it.
Frequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I design a REST API?
dev-api-design teaches REST API fundamentals including resource modeling, HTTP method semantics, status codes, and contract-first approaches. The skill covers designing endpoints that follow REST principles, structuring payloads, and implementing proper HTTP semantics for CRUD operations and complex workflows.
REST vs GraphQL vs gRPC—which should I use?
dev-api-design helps you evaluate each style: REST for simple CRUD and public APIs, GraphQL for flexible client queries and reducing over-fetching, and gRPC for high-performance internal services. The skill guides tradeoffs in complexity, caching, tooling, and team expertise to match your use case.
What are the best API versioning strategies?
dev-api-design covers versioning approaches including URL paths, headers, and content negotiation, plus deprecation policies and breaking-change detection. It teaches how to plan API evolution, communicate changes to consumers, and maintain backward compatibility or manage controlled transitions.
How do I write an OpenAPI specification?
dev-api-design guides OpenAPI spec authoring for documenting REST APIs with schemas, parameters, responses, and security definitions. The skill shows how to generate interactive documentation, validate requests against specs, and use specs for code generation and contract testing.
How should I implement authentication and rate limiting?
dev-api-design covers JWT and OAuth2 authentication patterns, API key management, and rate-limiting strategies (token bucket, sliding window). It includes authorization checks, token refresh flows, and designing rate limits that protect backend resources while respecting client needs.
What error handling patterns should production APIs follow?
dev-api-design teaches RFC 9457 problem details format for structured error responses, HTTP status code semantics, and error recovery strategies. The skill covers logging errors for observability, communicating failures clearly to clients, and designing retry-safe operations.
SKILL.md
Rendered from the published skill. Quoted content, verbatim.
API Development & Design — Quick Reference
Use this skill to design, implement, and document production-grade APIs (REST, GraphQL, gRPC, and tRPC). Apply it for contract design (OpenAPI), versioning/deprecation, authentication/authorization, rate limiting, pagination, error models, and developer documentation.
Modern best practices (Jan 2026): HTTP semantics and cacheability (RFC 9110), Problem Details error model (RFC 9457), OpenAPI 3.1+, contract-first + breaking-change detection, strong AuthN/Z boundaries, explicit versioning/deprecation, and operable-by-default APIs (idempotency, rate limits, observability, trace context).
Default Execution Checklist
- Choose an API style based on constraints (public vs internal, performance, client query flexibility).
- Define the contract first (OpenAPI or GraphQL schema; protobuf for gRPC).
- Define the error model (RFC 9457 + stable error codes + trace IDs).
- Define AuthN/AuthZ boundaries (scopes/roles/tenancy) and threat model.
- Define
(truncated - see the full file via the links below)
File tree — 15 files
frameworks/shared-skills/skills/dev-api-design/SKILL.md
frameworks/shared-skills/skills/dev-api-design/assets/cross-platform/api-patterns-universal.md
frameworks/shared-skills/skills/dev-api-design/assets/cross-platform/template-api-design-review-checklist.md
frameworks/shared-skills/skills/dev-api-design/assets/cross-platform/template-api-error-model.md
frameworks/shared-skills/skills/dev-api-design/assets/cross-platform/template-api-governance.md
frameworks/shared-skills/skills/dev-api-design/assets/django-rest/django-rest-complete-api.md
frameworks/shared-skills/skills/dev-api-design/assets/express-nodejs/express-complete-api.md
frameworks/shared-skills/skills/dev-api-design/assets/fastapi/fastapi-complete-api.md
frameworks/shared-skills/skills/dev-api-design/assets/openapi-template.yaml
frameworks/shared-skills/skills/dev-api-design/assets/spring-boot/spring-boot-complete-api.md
frameworks/shared-skills/skills/dev-api-design/data/sources.json
frameworks/shared-skills/skills/dev-api-design/references/api-design-best-practices.md
frameworks/shared-skills/skills/dev-api-design/references/api-security-checklist.md
frameworks/shared-skills/skills/dev-api-design/references/api-testing-patterns.md
frameworks/shared-skills/skills/dev-api-design/references/authentication-patterns.md
Let your AI agent find skills like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 56,283 agent skills by what they can do, searchable in plain language.
wish › “Design a production-grade REST, GraphQL, gRPC, or tRPC API with proper contracts and patterns”
Give your agent the search over MCP, or paste the wish link into any chat. No install? Search from any chat →
Related skills
Make informed architecture decisions for new systems or major refactors. This skill guides you through pattern selection, scalability design, resilience strategies, and data consistency models—with concrete technology recommendations and tradeoff analysis. Covers decomposition, service boundaries, observability planning, and migration from legacy systems.
Select and implement the optimal API pattern for your backend needs. This skill guides you through REST, GraphQL, gRPC, and tRPC with framework recommendations for Python, TypeScript, Rust, and Go, plus pagination, caching, rate limiting, and OpenAPI documentation strategies.
Build APIs that developers love using. This skill covers RESTful conventions, proper HTTP method semantics, consistent error responses, pagination strategies, and versioning approaches. Learn how thoughtful naming, clear status codes, and predictable patterns make APIs intuitive and maintainable.
Learn to design APIs by understanding when to use REST, GraphQL, or tRPC, and how to structure responses, handle versioning, and secure your endpoints. This skill covers decision-making frameworks rather than fixed templates, helping you choose the right approach for your specific context.
Learn to design and build RESTful APIs using proven patterns for resource modeling, HTTP semantics, and API architecture. This skill covers naming conventions, CRUD operations, versioning strategies, pagination, filtering, error handling, and hypermedia controls with FastAPI and Express.js examples.
API Design Expert provides comprehensive guidance on building scalable APIs using REST, GraphQL, and other modern patterns. Learn resource-oriented design, stateless architecture, versioning strategies, and critical practices like authentication, rate limiting, and structured error handling to ensure your APIs are secure, maintainable, and performant.
More skills django-patterns (MIT)