技术文档
一键生成
API 规格 → AI 排版 → 导出 Word/PDF
// Agent 会话日志
"从我们的 OpenAPI 规格生成 API 参考文档。企业格式,包含 Python 和 JS 示例,变更日志章节,导出 DOCX 和 PDF。"
// 规划执行顺序
- → 解析 openapi.yaml — 提取接口和 Schema
- → 应用企业 .dotx 模板
- → 生成带参数和响应的接口章节
- → 插入 Python + JS 代码示例
- → 自动生成目录 + 索引 + changelog
$ ap-docs new --type api-reference --template enterprise-docs
✓ Document created from enterprise template
$ ap-docs parse-openapi --input openapi.yaml --sections endpoints,schemas
✓ Parsed: 42 endpoints, 18 request/response schemas
$ ap-docs generate-sections --code-examples python,javascript
✓ 42 endpoint sections with dual-language code blocks
$ ap-docs export --word --pdf --toc --index
✓ api-reference-v2.docx (84 pages) · api-reference-v2.pdf
// 此场景支持的能力
OpenAPI / Swagger 导入
解析 YAML 或 JSON 规格文件,自动生成接口章节。
多语言代码示例
为每个接口自动生成 curl、Python、JavaScript、Go、Java 示例。
自动目录 + 索引
从标题生成目录和全文索引,PDF 中可点击导航。
企业模板支持
应用带公司 Logo、页眉和页脚的 .dotx 模板。
多格式输出
导出为 DOCX、PDF、ODT 或 HTML,保留代码块和表格。
规格变更自动更新
用更新后的规格文件重新运行,文档增量更新。