api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications and mock servers.

Updated May 31, 2026
One-click install
npx skills add https://github.com/fanguyun/SkillManager --skill api-designer-fanguyun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/fanguyun/SkillManager/tree/main/api-designer
Command: npx skills add https://github.com/fanguyun/SkillManager --skill api-designer-fanguyun

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill provides comprehensive support for designing, documenting, and planning REST or GraphQL APIs, addressing common challenges like versioning, pagination, and error handling.

Core Features & Use Cases

  • API Design Workflow: Offers a structured process for designing APIs from scratch.
  • OpenAPI Specification: Generates and validates OpenAPI 3.1 specifications.
  • Mock Server: Enables testing of API contracts.
  • Reference Guides: Provides detailed guides on various API design topics.
  • Templates: Offers ready-to-use templates for common API elements.

Quick Start

Invoke the api-designer skill to begin designing your API.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design and document a REST API using OpenAPI 3.1 standards?

To design and document a REST API with OpenAPI 3.1, this Skill generates and validates specifications while providing structured workflows and templates to ensure architectural best practices. It streamlines creating robust API documentation.

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

Handling API versioning and pagination in GraphQL is facilitated through expert guidance on architectural best practices. The Skill provides structured reference materials to address these common API design challenges effectively.

Can I generate a mock server to test my API contracts?

Yes, you can generate a mock server to test API contracts directly. The Skill includes built-in tools for mock server creation, enabling you to validate endpoints and interactions before finalizing your API design.

Do I need prior knowledge of REST and OpenAPI to use this API design workflow?

Yes, a deep understanding of REST, OpenAPI, and API versioning is required. The Skill offers advanced design workflows and reference guides that assume you are already familiar with these foundational API concepts.

Are there ready-to-use templates for common API elements like error handling?

Yes, there are ready-to-use templates for common API elements like error handling. The Skill supplies these templates alongside detailed reference guides to solve challenges such as pagination and versioning.