yapi

Query and synchronize YApi interface documentation from URLs and local config.

168|22|Updated Jun 26, 2025
One-click install
npx skills add https://github.com/leeguooooo/cross-request-master --skill yapi-leeguooooo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: yapi
Source: https://github.com/leeguooooo/cross-request-master/tree/main/packages/yapi-mcp/skill-template
Command: npx skills add https://github.com/leeguooooo/cross-request-master --skill yapi-leeguooooo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables quick access to and synchronization of YApi interface documentation by querying interfaces from URLs and local configurations, reducing manual lookup and manual doc generation.

Core Features & Use Cases

  • URL-based detection to determine when to fetch interface details from YApi through the CLI.
  • Workflow support for prerequisites and authentication, including verifying the YApi CLI installation and login status, and reading base configuration from the local config file.
  • End-to-end guidance for identifying target interfaces, retrieving raw JSON data, and generating summarized method, path, headers, and response schemas for teams.
  • Docs-sync integration to bind local docs to YApi categories and render up-to-date documentation for collaborative workflows.

Quick Start

Provide a YApi URL or binding details and let the skill fetch and summarize the interface documentation.

Frequently Asked Questions about yapi

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

FAQPage Schema
How do I fetch and sync YApi interface documentation from a URL?

To fetch and sync YApi interface documentation, provide a YApi URL or binding details. The skill queries the YApi CLI to retrieve raw JSON data and generates summarized method, path, headers, and response schemas for your team.

What is YApi docs-sync and how does it work with local configs?

YApi docs-sync binds local documentation to YApi categories to render up-to-date documentation. It works by reading the base configuration from your local config file and using the YApi CLI to synchronize interface metadata for collaborative workflows.

Do I need a configured YApi CLI environment to query interface details?

Yes, querying YApi interface details requires a configured YApi CLI environment. You must have the YApi CLI installed, be logged in, and have a base_url specified in the ~/.yapi/config.toml file to fetch and summarize interface metadata.

Can I automatically generate API docs from YApi using a CLI?

Yes, you can automatically generate API docs from YApi using the CLI. By providing a YApi URL, the skill retrieves raw JSON data and renders up-to-date, summarized documentation including methods, paths, and response schemas for collaborative workflows.

What are the limitations of syncing YApi interface documentation locally?

Syncing YApi interface documentation depends entirely on the YApi CLI environment. It requires proper authentication, a valid login status, and a correctly configured base_url in ~/.yapi/config.toml, meaning it will not work without these local prerequisites.

How do I verify my YApi CLI setup before fetching interface metadata?

To verify your YApi CLI setup before fetching interface metadata, ensure the CLI is installed and you are logged in. The skill provides workflow support for checking these prerequisites and reading the base configuration from your local config file.