# Api Docs

> 按项目规范编写 API 文档。使用场景：用户要求写接口文档、补充 API 说明、为第三方或内部接口编写文档时。

- **Type:** Skill
- **Install:** `agentstack add skill-xiongxianzhu-xskills-api-docs`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [xiongxianzhu](https://agentstack.voostack.com/s/xiongxianzhu)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [xiongxianzhu](https://github.com/xiongxianzhu)
- **Source:** https://github.com/xiongxianzhu/xskills/tree/main/skills/api-docs

## Install

```sh
agentstack add skill-xiongxianzhu-xskills-api-docs
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# API 文档（api-docs）

按 [references/specification.md](references/specification.md) 编写 API 文档，保证格式统一、可供第三方或前端对接。

## 何时使用

- 撰写、补充或修订接口说明、对接文档
- 为第三方或内部调用方提供可实现的 API 描述

## 工作流程

1. 从路由与实现代码提取真实路径、参数名、类型与错误码，避免编造字段。
2. 遵守规范中的章节结构、表格列、Markdown 约束与「禁止省略」条款。
3. 版式与接口小节写法对照 [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](https://github.com/xiongxianzhu)
- **Source:** [xiongxianzhu/xskills](https://github.com/xiongxianzhu/xskills)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-xiongxianzhu-xskills-api-docs
- Seller: https://agentstack.voostack.com/s/xiongxianzhu
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.