skills.rest
innexar-plat
innexar-platCOMMUNITY
Explore all skills by this author →
GitHub

dev-api-design

Designs contract-first REST, GraphQL, gRPC and tRPC APIs with OpenAPI 3.1, RFC 9457 errors, RBAC/JWT auth, pagination, rate limiting, CI checks, and observability support.

Updated Apr 10, 2026
Search Tags:#openapi#rest#graphql#trpc#rate-limiting#grpc#api-design
One-click install
npx skills add https://github.com/innexar-plat/Master-Coat-Solutions --skill dev-api-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dev-api-design
Source: https://github.com/innexar-plat/Master-Coat-Solutions/tree/main/.github/skills/dev-api-design
Command: npx skills add https://github.com/innexar-plat/Master-Coat-Solutions --skill dev-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Design and document robust, maintainable APIs so teams can ship interoperable services without ambiguity, inconsistent contracts, or operational surprises. It reduces friction across client and server teams by prescribing contract-first workflows, clear error models, versioning, auth boundaries, and operability standards so integrations are predictable and safe.

Core Features & Use Cases

  • Define API contracts first (OpenAPI 3.1 / GraphQL schema / protobuf) and run breaking-change checks in CI.
  • Standardize error handling with RFC 9457 Problem Details, stable error codes, and trace IDs for debuggability.
  • Architect pagination, filtering, idempotency, rate limiting (token-bucket), and observability (W3C Trace Context, request IDs).
  • Provide templates and full-stack examples (FastAPI, Express, Django, Spring Boot) for rapid implementation and developer docs.
  • Use when designing public developer APIs, internal microservice contracts, agent-friendly endpoints, or migrating versions.

Quick Start

Request an OpenAPI 3.1 contract for a public REST orders API including JWT auth, cursor pagination, RFC 9457 error responses, and tiered rate limits.

Frequently Asked Questions about dev-api-design

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

FAQPage Schema
How do I design an OpenAPI 3.1 contract with JWT auth and cursor pagination?▼

To design an OpenAPI 3.1 contract with JWT auth and cursor pagination, define your API endpoints first, specify JWT security schemes, implement cursor-based pagination parameters, and validate the contract using breaking-change checks in CI.

What's the best way to standardize API error handling across microservices?▼

The best way to standardize API error handling is to use RFC 9457 Problem Details format with stable error codes and W3C Trace Context trace IDs, ensuring debuggability and consistent error responses across all microservices.

How do I implement idempotency and token-bucket rate limiting for a REST API?▼

You implement idempotency and token-bucket rate limiting by defining idempotency keys for safe retries in your API contract and architecting tiered token-bucket rate limits to control request throughput per client.

Can I use this contract-first API approach with GraphQL and gRPC?▼

Yes, you can use this contract-first approach with GraphQL and gRPC. It supports generating GraphQL schemas and protobuf definitions, applying consistent versioning, deprecation, and authentication boundaries across REST, GraphQL, gRPC, and tRPC.

How do I detect breaking changes in API specifications during CI?▼

You detect breaking API changes in CI by defining contract-first OpenAPI 3.1, GraphQL, or protobuf specifications, then running automated breaking-change detection checks against previous specification versions during your pipeline.

Does this API design process work with FastAPI and Spring Boot?▼

Yes, this API design process works with FastAPI and Spring Boot. It provides templates and full-stack examples for both frameworks to rapidly implement contract-first definitions, developer docs, and operability standards.

Related Skills

Explore More Software Engineering Skills→
botPhUbotPhU

rest-api-expert

Design REST APIs with versioning, error handling, and OpenAPI specs.

Community
Advanced
xotongxotong

openapi-spec-generation

Generate or update OpenAPI 3.1 specs from API route changes.

Community
Intermediate
vertivolatamvertivolatam
1

API Gateway & Rate Limiting

Implement API Gateways with Kong and Nginx rate limiting strategies.

Official
Advanced
k1lgork1lgor
2

api-designer

Standardize REST and GraphQL API designs with routes, schemas, and OpenAPI specifications.

Community
Intermediate