SuperAPI AI 工具集

interface-data-doc-generator

编程与开发

查看项目

更新于 10-15 17:12

技能介绍

用途:面向新项目启动或文档整理场景,根据架构文档、需求描述或接口列表生成标准化技术文档,并对现有文档做审查与优化。

主要能力:

  1. 文档生成:API 接口文档(OpenAPI 3.0、Postman Collection)、数据库设计文档(表结构、数据字典、索引策略)、通信协议文档(WebSocket、Protobuf、FlatBuffers)。
  2. 文档分析与优化:完整性、规范性、格式检查,并给出数据结构与索引优化建议。
  3. 多语言多架构:后端 Java/SpringBoot、Go/Gin、Python/Django/Flask/FastAPI、Node.js/Express/NestJS;前端 React、Vue、Angular、Svelte、Next.js、Nuxt.js;数据库 MySQL、PostgreSQL、Oracle、MongoDB;协议 RESTful、GraphQL、WebSocket、gRPC。
  4. 多端差异管理:为 Web、移动端、小程序生成差异化字段与版本说明。
  5. 需求变更分析:对比前后差异,识别受影响接口/表/协议,给出兼容性建议。
  6. 完整性校验:检查必需章节与示例完整性。

使用方式:智能体读取需求后参考模板(references/api-doc-template.md、db-doc-template.md、protocol-template.md)生成文档,并按需调用验证脚本: python scripts/validate_openapi.py openapi.yaml python scripts/validate_protobuf.py schema.proto python scripts/validate_sql.py schema.sql

依赖包:pyyaml>=6.0、jsonschema>=4.17.0、protobuf>=4.21.0。

适用场景:前后端接口文档编写、数据库设计评审、实时通信协议定义(如游戏 WebSocket+Protobuf)、多端接口差异管理。

限制:文档生成主要由智能体完成,验证脚本仅在需要格式校验时调用;脚本失败需检查路径、文件格式和依赖安装;资料未提供收费、价格、平台与效果信息。