SuperAPI AI 工具集

api-documentation

编程与开发

查看项目

更新于 10-15 17:27

技能介绍

用途:为 API 与代码接口提供统一的文档编写规范,减少各智能体中约100-150行重复的文档指导内容。

主要能力:

  • 核心原则:说明“为什么”而非仅“是什么”,文档贴近代码,描述契约而非实现,示例必备,随代码同步更新。
  • 函数/方法文档:给出 Python docstring、JavaScript JSDoc、Go Godoc 的写法,涵盖参数、返回值、异常与示例。
  • 接口文档:包含 REST(OpenAPI/Swagger)与 GraphQL 的描述方式,如路径参数、响应码、类型说明。
  • 类/模块文档:说明类职责、属性、示例、线程安全与注意事项。
  • README 结构:项目名、功能、安装、快速开始、配置、API 参考、贡献与许可。
  • 反模式:指出冗余注释、过期文档、记录实现细节等错误做法。
  • 工具清单:Python 的 Sphinx、pdoc、MkDocs;JavaScript 的 JSDoc、TypeDoc、Docusaurus;Go 的 godoc、pkgsite;Rust 的 rustdoc。
  • 检查清单:涵盖公共 API、参数、异常、示例、边界情况、README、API 参考、配置项、同步更新与破坏性变更。

使用方式与限制:资料未提供具体安装命令或调用步骤,仅以示例代码展示文档写法。适用于需要统一文档规范的开发场景,具体平台与收费情况暂未提供。