rx782-fss/claude-howto-zh/doc-generator

Claude Code and agent skill by rx782-fss/claude-howto-zh

Trust tier 2
  • community
LLM review pending
Source check pending

Checking that the SKILL.md file is still in the repository.

从源代码生成全面、准确的 API 文档。用于创建或更新 API 文档、生成 OpenAPI 规范,或当用户提及 API 文档、接口端点、文档时使用。

Install

npx vskill@latest install rx782-fss/claude-howto-zh/doc-generator

SKILL.md

API 文档生成器技能

生成内容

  • OpenAPI/Swagger 规范
  • API 接口文档
  • SDK 使用示例
  • 集成指南
  • 错误码参考
  • 认证指南

文档结构

每个接口端点的文档格式
markdown
## GET /api/v1/users/:id
 
### 接口说明
简要解释该接口的功能
 
### 请求参数
 
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| id | string | 是 | 用户 ID |
 
### 响应
 
**200 成功**

{ "id": "usr_123", "name": "张三", "email": "zhangsan@example.com", "created_at": "2025-01-15T10:30:00Z" }

 
**404 未找到**

{ "error": "USER_NOT_FOUND", "message": "用户不存在" }

 
### 使用示例
 
**cURL**

curl -X GET "https://api.example.com/api/v1/users/usr_123" \ -H "Authorization: Bearer YOUR_TOKEN"

 
**JavaScript**

const user = await fetch('/api/v1/users/usr_123', { headers: { 'Authorization': 'Bearer token' } }).then(r => r.json());

 
**Python**

response = requests.get( 'https://api.example.com/api/v1/users/usr_123', headers={'Authorization': 'Bearer token'} ) user = response.json()

Security
  • Security scanPassed, 100 of 100Pattern checks on the skill's files.
  • Model reviewNot runA model review is scheduled for the next rescan.
See the full security report
Quality evaluation
  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
See evaluation results
Source
Popularity
Repository stars
89
Repository forks
15
7-day trend score
22
Stars and forks are for the whole GitHub repository, not this skill alone. Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/rx782-fss/claude-howto-zh/doc-generator/badge)](https://verified-skill.com/skills/rx782-fss/claude-howto-zh/doc-generator)
Something wrong with this skill or its page? Tell us.