skills.rest
zhouguoqing
zhouguoqingCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Standardize REST API contracts for resource modeling, versioning, and OpenAPI documentation.

23|2|Updated May 27, 2026
Search Tags:#design#versioning#documentation#api#openapi#rest#contracts
One-click install
npx skills add https://github.com/zhouguoqing/QianYuan.AIAgenticFramework --skill api-design-zhouguoqing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/zhouguoqing/QianYuan.AIAgenticFramework/tree/main/samples/skills/api-design
Command: npx skills add https://github.com/zhouguoqing/QianYuan.AIAgenticFramework --skill api-design-zhouguoqing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardize REST API contracts to reduce ambiguity and drift across services.

Core Features & Use Cases

  • Guided API Contract Design: Define resources, endpoints, versions, error schemas, and pagination.
  • OpenAPI Alignment: Generate and align OpenAPI specifications for client-server compatibility.
  • Use Case Scenarios: Effective for design reviews, multi-team onboarding, and API migrations.

Quick Start

Draft a provisional REST API contract starting from provided use cases and resources.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I standardize REST API contracts across multiple teams?▼

To standardize REST API contracts across multiple teams, you enforce consistent resource modeling, versioning strategies, error envelopes, and OpenAPI documentation to reduce ambiguity and drift across services.

What's the best way to design REST API versioning and error handling?▼

Designing REST API versioning and error handling requires applying standardized naming conventions, specific versioning strategies, and consistent error envelopes to maintain client compatibility during API evolution.

How do I align OpenAPI specifications with REST API resources?▼

Align OpenAPI specifications with REST API resources by defining resources, endpoints, versions, and error schemas to generate aligned documentation that ensures client-server compatibility.

When do I need to standardize REST API pagination and observability?▼

You need to standardize REST API pagination and observability when managing API evolution across multiple teams, ensuring consistent client compatibility and reducing drift across distributed services.

Can I draft a provisional REST API contract from existing use cases?▼

Yes, you can draft a provisional REST API contract starting from provided use cases and resources to guide resource modeling, authentication, and OpenAPI documentation generation.

Does this approach work for API migrations and multi-team onboarding?▼

Yes, this REST API contract standardization is effective for design reviews, multi-team onboarding, and API migrations, guiding endpoint definitions and consistent client compatibility.

Related Skills

Explore More Software Engineering Skills→
itentialitential
13

itential-lcm

Automates lifecycle management of resources, instances, and actions in Itential Lifecycle Manager.

Official
Advanced
GP-CRM-SystemGP-CRM-System

openapi-spec-generation

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

Official
Advanced
randalmurphalrandalmurphal

api-design-patterns

Standardize REST API design with versioning, pagination, RFC 7807 errors, and OpenAPI documentation.

Community
Advanced
cookeyholdercookeyholder

api-and-interface-design

Define stable REST or GraphQL API contracts before implementation.

Community
Intermediate