skills.rest
CODE-SAURABH
CODE-SAURABHCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST, GraphQL, gRPC, WebSocket, and webhook API contracts with OpenAPI documentation.

2|1|Updated Jul 25, 2026
Search Tags:#versioning#api design#openapi#rest#graphql#grpc#api security
One-click install
npx skills add https://github.com/CODE-SAURABH/OpenSkills --skill api-design-code-saurabh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/CODE-SAURABH/OpenSkills/tree/main/api-design
Command: npx skills add https://github.com/CODE-SAURABH/OpenSkills --skill api-design-code-saurabh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill prevents inconsistent, fragile, and difficult-to-integrate APIs by guiding you through contract-first design, clear standards, versioning, error handling, security, and developer experience.

Core Features & Use Cases

  • API Style Selection: Choose and structure REST, GraphQL, gRPC, WebSocket, or webhook APIs based on the product's requirements.
  • Production-Grade Contracts: Define consistent resources, schemas, pagination, errors, authentication, rate limits, and versioning strategies.
  • OpenAPI Review: Create or evaluate OpenAPI 3.x specifications with reusable schemas, operation identifiers, realistic examples, and documented responses.
  • Use Case: Design a versioned REST API for a user-management service with cursor pagination, standardized validation errors, bearer authentication, rate-limit headers, and a complete OpenAPI contract.

Quick Start

Use the api-design skill to design a production-grade API for your specified resources, clients, operations, security requirements, and performance constraints.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a production-grade REST API with pagination and standardized errors?▼

To design a production-grade REST API, define consistent resources, schemas, cursor pagination, standardized validation errors, and rate-limit headers. This contract-first approach ensures stable naming and correct protocol semantics for reliable client integration.

What's the best way to choose between REST, GraphQL, and gRPC for API design?▼

API style selection between REST, GraphQL, gRPC, WebSocket, and webhooks depends on your product requirements. Structure the API based on client operations and performance constraints to satisfy contract-first development requirements.

How do I create an OpenAPI 3.x specification with reusable schemas and realistic examples?▼

Create OpenAPI 3.x specifications by defining reusable schemas, operation identifiers, realistic examples, and documented responses. Reviewing your OpenAPI contract ensures production-grade standards are met with proper validation and security controls.

Does contract-first API design work with gRPC and WebSocket protocols?▼

Contract-first API design works with gRPC and WebSocket scenarios by applying correct protocol semantics, compatibility policies, and validation standards. You define schemas, authentication, and security controls tailored to these specific communication protocols.

How do I handle API versioning and authentication to prevent fragile integrations?▼

Handle API versioning and authentication by applying clear standards, compatibility policies, and security controls like bearer authentication. This prevents inconsistent, fragile APIs by guiding you through contract-first design, error handling, and developer experience.

Related Skills

Explore More Software Engineering Skills→
ali-masterali-master
8

oRPC Define Contract

Define oRPC API contracts and generate TypeScript code.

Community
Intermediate
hjemmesidekongenhjemmesidekongen
1

openapi-typescript

Generate TypeScript types and clients from OpenAPI 3.x and Swagger 2.0 specifications.

Community
Advanced
Oruga420Oruga420

api-design

Design REST API conventions for resource naming, HTTP methods, and pagination.

Community
Advanced
tinkermonkeytinkermonkey

LAYER_07_DATA_MODEL

Define and validate object data structures using JSON Schema Draft 7.

Community
Advanced