skills.rest
Abdullahmohammadaref
AbdullahmohammadarefCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST, GraphQL, and gRPC APIs with OpenAPI 3.1 specifications.

Updated May 6, 2026
Search Tags:#design#api#openapi#rest#graphql#pagination#grpc
One-click install
npx skills add https://github.com/Abdullahmohammadaref/acar --skill api-design-abdullahmohammadaref
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Abdullahmohammadaref/acar/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/Abdullahmohammadaref/acar --skill api-design-abdullahmohammadaref

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

API design is the practice of defining the contract between a service and its consumers in a way that is consistent, predictable, and resilient to change. A well-designed API reduces integration friction, makes versioning safe, and communicates intent through naming and structure.

Core Features & Use Cases

  • Design REST, GraphQL, and gRPC interfaces with consistent naming, versioning, and error handling.
  • Produce OpenAPI specifications, implement pagination, and model authentication patterns.
  • Apply reusable component patterns and security schemes to improve maintainability.

Quick Start

Install the api-design skill and start receiving API design guidance in your coding sessions.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design consistent API pagination and versioning across REST and GraphQL?▼

API design for REST and GraphQL requires consistent pagination and versioning strategies to reduce integration friction. Standardizing these contracts ensures predictable service behavior and maintains version safety across different interface types.

What is the best way to standardize API error formats using OpenAPI specifications?▼

Standardizing API error formats involves applying RFC 7807 error handling within your OpenAPI 3.1 specifications. This approach enforces consistent error communication, improving maintainability and reducing consumer integration friction.

How do I model authentication patterns for gRPC and REST APIs in production?▼

Modeling authentication patterns for gRPC and REST involves defining reusable security schemes within your API architecture. Applying these standardized patterns ensures consistent authorization across production environments.

When do I need OpenAPI 3.1 specifications for API architecture decisions?▼

You need OpenAPI 3.1 specifications when defining service contracts to ensure consistent, predictable, and resilient API architecture. These specs standardize naming, structure, and security schemes for production consumers.

Does this API design approach work for both gRPC and GraphQL interfaces?▼

Yes, this API design approach shapes robust interfaces across REST, GraphQL, and gRPC. It standardizes naming, versioning, and error handling uniformly across all three protocol types.

Why does consistent API naming structure reduce integration friction?▼

Consistent API naming reduces integration friction by clearly communicating service intent through predictable structure. This practice makes versioning safe and establishes a resilient contract between services and consumers.

Related Skills

Explore More Software Engineering Skills→
zazzcodezazzcode
3

qa-backend

Validate API contracts, auth checks, and data integrity in backend deliverables.

Community
Advanced
ccfccf

openapi-spec-generation

Generate and validate OpenAPI 3.1 specifications from design or code sources.

Community
Advanced
microwindmicrowind
65

API网关设计

Design API gateways for routing, security, and traffic management in microservices.

Official
Advanced
erichowenserichowens
181

api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

Community
Advanced