api-designer

Design REST APIs and generate OpenAPI 3.1 specifications with mock server testing.

Updated Mar 20, 2026
One-click install
npx skills add https://github.com/chestnut0698/BUPT-DS-Personalized-Tourism-System --skill api-designer-chestnut0698
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/chestnut0698/BUPT-DS-Personalized-Tourism-System/tree/main/.agents/skills/api-designer
Command: npx skills add https://github.com/chestnut0698/BUPT-DS-Personalized-Tourism-System --skill api-designer-chestnut0698

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill unit assists in the design and documentation of APIs, streamlining the process for architects and developers.

Core Features & Use Cases

  • API Modeling: Offers resource modeling and versioning strategies for REST and GraphQL APIs.
  • Documentation Generation: Automatically generates OpenAPI 3.1 specifications for API contracts.
  • Mock Server: Provides a mock server for testing API contracts and endpoint validations.
  • Reference Guides: Includes detailed guides for REST patterns, versioning, pagination, and error handling.

Quick Start

To design a REST API, use the api-designer skill to create an OpenAPI 3.1 specification for the '/users' endpoint with pagination support.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I generate an OpenAPI 3.1 specification for a REST API?

You can generate an OpenAPI 3.1 specification by defining your resource modeling and endpoint versioning strategies, which the skill automatically translates into a formal API contract document.

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

The best way to handle API versioning and pagination is using the included reference guides, which provide detailed patterns and strategies for structuring RESTful endpoints and managing resource state evolution.

Can I test API contracts and validate endpoints without a live backend?

Yes, you can test API contracts and validate endpoints without a live backend by utilizing the provided mock server environment to simulate requests and verify RESTful principles and error handling.

Does this API design tool support both REST and GraphQL resource modeling?

Yes, this API design tool supports both REST and GraphQL resource modeling, offering comprehensive guidance on structuring resources, versioning strategies, and endpoint documentation for both architectural styles.

How do I structure error handling and versioning for a RESTful API?

To structure error handling and versioning for a RESTful API, apply the detailed reference guides included in the skill, which outline standard REST patterns for pagination, errors, and version control.

Do I need a mock server environment to design APIs with OpenAPI specifications?

Yes, a mock server environment is required to test API contracts and validate endpoint behaviors after generating your OpenAPI 3.1 specifications during the API design process.