# Doc Generator

> 从源码生成准确、完整的 API 文档和技术说明。Use when creating or updating API docs, generating endpoint documentation, or when users mention API docs, endpoints, or documentation.

- Skill: `lhfer/doc-generator` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add lhfer/doc-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/lhfer/doc-generator/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: lhfer (https://skillmd.com/u/lhfer)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/lhfer/doc-generator

---


# API Documentation Generator Skill / API 文档技能

## 生成内容

- OpenAPI / Swagger 文档
- endpoint 文档
- SDK 示例
- 集成指南
- 错误码说明
- 鉴权说明

## 每个 endpoint 需要包含

输出尽量包含：

- Description（说明）
- Parameters（参数）
- Response
- Errors
- cURL / JavaScript / Python 示例

要求：

- 文档结构清晰
- 示例可复制
- 与源码保持一致