Api Docs
按项目规范编写 API 文档。使用场景：用户要求写接口文档、补充 API 说明、为第三方或内部接口编写文档时。
— No reviews yet
0 installs
3 views
0.0% view→install
Install
$ agentstack add skill-xiongxianzhu-xskills-api-docs ✓ scanned · ✓ verified — works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Are you the author of Api Docs? Claim this listing to set pricing, connect Stripe payouts, and keep 70% of every sale.
Sign up to claimAbout
API 文档（api-docs）
按 [references/specification.md](references/specification.md) 编写 API 文档，保证格式统一、可供第三方或前端对接。
何时使用
- 撰写、补充或修订接口说明、对接文档
- 为第三方或内部调用方提供可实现的 API 描述
工作流程
- 从路由与实现代码提取真实路径、参数名、类型与错误码，避免编造字段。
- 遵守规范中的章节结构、表格列、Markdown 约束与「禁止省略」条款。
- 版式与接口小节写法对照 [references/examples.md](references/examples.md)；若为已有文档增量编辑，保持与既有小节风格一致。
参考文件
references/specification.md— 章节结构、参数表约定与禁止省略规则references/examples.md— 虚构「图书管理系统」完整示例
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: xiongxianzhu
- Source: xiongxianzhu/xskills
- License: MIT
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet — be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.