chinese-interface-doc-generator
Installation
SKILL.md
接口文档生成助手
此技能为中文开发者自动分析代码中的接口定义(函数、类、模块、API端点等),提取中文注释和文档字符串,生成简洁清晰的中文接口文档。专注于内部文档、快速原型和团队协作场景,支持交互式选项选择。
区别于OpenAPI生成器:通用接口支持(非仅API)、中文优先、简单交互、无复杂规范验证。
能力
- 接口分析:识别Python/JS代码中的函数、类方法、API端点等接口定义
- 中文文档提取:优先提取中文注释、docstring,支持简繁体中文
- 多格式输出:Markdown、HTML、JSON,支持REST/GraphQL/函数接口
- 交互选项:选择详细程度(简要/详细)、格式、包含示例
- 报告生成:一键生成完整中文接口报告,保存为时间戳文件
- 团队友好:简洁输出,便于中文团队审阅和协作