A specialized skill for Openclaw Skills that enables seamless querying, searching, and synchronization of YApi interface documentation.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install yapi
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install yapi using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is YApi Interface Docs Sync?
The YApi skill provides a robust bridge between your AI coding agent and your YApi documentation server. It allows developers to interact with API definitions directly through the command line or AI prompts, ensuring that code implementation stays perfectly aligned with documented interfaces. By leveraging the Openclaw Skills framework, this tool automates the retrieval of request/response details and simplifies the process of keeping local documentation repositories in sync with the remote YApi source of truth.
This skill is particularly valuable for teams using YApi as their central API management platform. It supports complex workflows like URL detection for automatic context loading and structured synchronization tasks, making it an essential part of the Openclaw Skills ecosystem for full-stack and frontend developers.
YApi Interface Docs Sync Use Cases
- Searching for specific API endpoints using keywords or project IDs.
- Fetching detailed request/response schemas and examples for implementation.
- Automatically resolving YApi documentation when a user pastes a relevant URL.
- Synchronizing local Markdown or project documentation with the YApi server.
- Validating API interface structures during creation or update operations.
How YApi Interface Docs Sync Works
- The agent detects a YApi-related prompt or URL and checks the configured base_url in ~/.yapi/config.toml.
- It verifies authentication status using yapi whoami and prompts for login if required.
- The skill resolves the specific target by extracting api_id or project_id from the context.
- It fetches raw JSON data from the YApi server and provides a technical summary including headers, parameters, and body schemas.
- For documentation synchronization, it evaluates bindings and executes the sync process, often starting with a dry-run for safety.
YApi Interface Docs Sync Setup
To get started with this skill in Openclaw Skills, ensure you have the CLI tool available:
# Check if yapi is installed
yapi -h
# Or use via npx for one-shot execution
npx -y @leeguoo/yapi-mcp -h
Configure your environment by editing the ~/.yapi/config.toml file to set your base_url.
YApi Interface Docs Sync Data Schema & Taxonomy
The skill utilizes several configuration and cache files to maintain state and bindings:
| File Location | Description |
|---|---|
| ~/.yapi/config.toml | Global configuration including the YApi base URL. |
| ~/.yapi-mcp/auth-*.json | Cached authentication tokens and session data. |
| .yapi/docs-sync.json | Local project bindings for documentation synchronization. |
| .yapi/docs-sync.links.json | Metadata mapping remote IDs to local documentation files. |
It also generates auxiliary files like docs-sync.projects.json and docs-sync.deployments.json during advanced sync operations.
YApi Interface Docs Sync Advanced Features
- Binding Mode: Associate specific YApi projects or categories with local directories for targeted syncing.
- Dry-Run Support: Preview documentation changes before applying them to the local filesystem.
- Diagram Rendering: Support for Mermaid, PlantUML, Graphviz, and D2 rendering within documentation if local tools are present.
- Interface Guardrails: Enforcement of structured request/response field definitions over free-text descriptions.
- Force Sync: Ability to bypass change detection and perform a full documentation refresh.
SKILL.md
Loading
Related Openclaw Skills
XHS Creator Center Skill
A professional automation skill for Xiaohongshu creators to securely manage logins, publish rich media content, and export performance data.
Work Report Generator
Automatically transforms your git commit history into structured, professional daily and weekly work reports grouped by project.
newsnow
A powerful command-line tool to fetch and structure trending news from over 60 global and regional sources.
Blog Content Publish
A powerful automation tool for publishing quality-gated editorial and news content with integrated CDN support and repository syncing.
ZenTao CLI Skill
A command-line interface for ZenTao that enables users to manage bug tracking and product lists directly from the terminal.
RT DNA Finder: Football Player Similarity Search
Find statistically similar footballers and cheaper alternatives using advanced vector DNA similarity search.
METADATA
Featured*
