skills.rest
fengqiliu
fengqiliuCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design RESTful, GraphQL, and gRPC API specifications with schemas and versioning.

2|Updated Mar 30, 2026
Search Tags:#versioning#rest#graphql#error-handling#pagination#grpc#api-design
One-click install
npx skills add https://github.com/fengqiliu/PM-Skills --skill api-design-fengqiliu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/fengqiliu/PM-Skills/tree/main/plugins/architect-plugin/skills/api-design
Command: npx skills add https://github.com/fengqiliu/PM-Skills --skill api-design-fengqiliu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides clear, practical guidance to design consistent, discoverable, and maintainable APIs across RESTful, GraphQL, and gRPC styles, reducing ambiguity and design rework between product and engineering teams.

Core Features & Use Cases

  • API Design Principles: Covers naming conventions, consistency, discoverability, versioning, and security best practices.
  • RESTful, GraphQL & gRPC Patterns: Includes URL and HTTP method guidance, status code conventions, pagination, filtering, schema examples, and proto/service definitions.
  • Documentation & Versioning: Offers documentation templates, deprecation strategies, and examples for error handling and pagination to support production-ready APIs.
  • Use Case: Ideal for backend engineers and product managers who need to define user, order, or inventory services with consistent endpoints, pagination, authentication, and clear error contracts.

Quick Start

Design a RESTful API for a user management service with endpoints for listing, creating, updating, and deleting users that includes pagination, filtering, authentication, and standardized error responses.

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 RESTful API endpoints for user management services?▼

To design RESTful APIs, define resource naming conventions, map HTTP methods to CRUD operations, and standardize status codes and error responses. This approach ensures endpoint schemas and request/response formats remain consistent for user management services.

What is the best way to handle pagination and filtering in API design?▼

Implementing standardized pagination strategies and filtering parameters within your request and response schemas ensures consistent data retrieval. This approach applies across RESTful, GraphQL, and gRPC services to support production-ready APIs.

How does error handling work across RESTful, GraphQL, and gRPC APIs?▼

Error handling across these API styles requires defining standardized error contracts and response formats. This includes using HTTP status code conventions for REST and specific schema or proto definitions for GraphQL and gRPC error management.

When do I need API versioning and how do I implement deprecation strategies?▼

API versioning is needed when updating endpoint schemas to avoid breaking existing clients. Implement deprecation strategies using documentation templates and clear communication of sunset dates across RESTful, GraphQL, and gRPC services.

Can I use the same API design principles for both REST and gRPC services?▼

Core API design principles like consistency, discoverability, and security apply to both REST and gRPC. Implementation differs as REST uses URL and HTTP method guidance, while gRPC relies on proto and service definitions for schemas.

Related Skills

Explore More Software Engineering Skills→
00PrabalK0000PrabalK00
1

api-contract-builder

Define and document API contracts with OpenAPI schemas before implementation.

Community
Intermediate
dreamingechoesdreamingechoes
2

api-design

Design RESTful endpoints, schemas, and documentation from requirements.

Community
Advanced
Serg28Serg28

api-designer

Create OpenAPI 3.1 YAML specifications with endpoints, schemas, and security.

Community
Intermediate
thesaifalitaithesaifalitai
8

api-designer

Design REST and GraphQL API architectures and generate OpenAPI 3.1 specifications.

Community
Advanced