skills.rest
davidrrowley
davidrrowleyCOMMUNITY
Explore all skills by this author →
Website𝕏@davidrrowleyGitHub

api-design

Design and validate REST, GraphQL, and gRPC API contracts with OpenAPI schemas.

Updated Apr 12, 2026
Search Tags:#versioning#openapi#rest#graphql#grpc#contract-first#api-design
One-click install
npx skills add https://github.com/davidrrowley/CortexYouV3 --skill api-design-davidrrowley
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/davidrrowley/CortexYouV3/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/davidrrowley/CortexYouV3 --skill api-design-davidrrowley

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Coordinating API design across REST, GraphQL, and gRPC can lead to mismatched expectations, brittle contracts, and duplicated effort. This skill provides a structured approach to defining stable, versioned API contracts before code, ensuring alignment between client and server.

Core Features & Use Cases

  • Contract-first design across REST, GraphQL, and gRPC with OpenAPI or equivalent schemas
  • Resource modeling, versioning strategies, and pagination patterns
  • Clear error contracts and consistent response structures
  • OpenAPI authoring, component reuse, and governance for multi-protocol APIs
  • Use Case: When starting a new API program, produce a single contract that covers REST endpoints, GraphQL types, and gRPC services

Quick Start

Create a sample OpenAPI contract for a hypothetical service and validate it with an OpenAPI linter.

Frequently Asked Questions about api-design

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

FAQPage Schema
What is contract-first API design and when should I use it?▼

Contract-first API design defines stable, versioned API schemas for REST, GraphQL, or gRPC before writing code. Use it to align client and server expectations, preventing brittle contracts and duplicated effort across multiple protocol types.

How do I structure an OpenAPI contract with reusable components and security definitions?▼

Structure OpenAPI contracts by defining reusable components, paths, and security definitions. This ensures proper schema reuse and clear project structure, satisfying OpenAPI authoring rules and governance for scalable multi-protocol APIs.

Can I use a single API design contract for REST endpoints, GraphQL types, and gRPC services?▼

Yes, you can produce a single contract covering REST endpoints, GraphQL types, and gRPC services. This structured approach scopes resource modeling, versioning strategies, and pagination patterns across multiple protocol types.

What is the best way to define error contracts and pagination patterns for scalable APIs?▼

The best way to define error contracts and pagination patterns is through a structured contract-first workflow. This ensures consistent response structures and stable versioning across REST, GraphQL, and gRPC protocols before implementation.

How do I validate an OpenAPI contract against authoring rules and governance standards?▼

Validate an OpenAPI contract by using an OpenAPI linter. This checks your schema for proper component reuse, clear project structure, and compliance with predefined security definitions and authoring rules.

Related Skills

Explore More Software Engineering Skills→
EGAdamsEGAdams

Receipt Scanning Tools Skill

Automate receipt data extraction and entry into the nonprofit_finance_db system.

Community
Advanced
Dokkabei97Dokkabei97
2

api-first-design

Design API contracts with OpenAPI and GraphQL schemas.

Community
Intermediate
AgentSecOpsAgentSecOps
183

api-spectral

Lint OpenAPI/AsyncAPI definitions with Spectral to enforce security and governance rules.

Official
Advanced
seifsheikhelarabseifsheikhelarab

openapi-spec-generation

Generate and validate OpenAPI 3.1 specifications from code and design artifacts.

Community
Advanced