自动从 Flask、Django、FastAPI、Express.js 代码生成统一格式的 API 文档，支持 Markdown、OpenAPI 和 Postman 导出。
api-doc-gen — API 文档自动生成器
功能概述
api-doc-gen — API 文档自动生成器是一项面向实际任务的技能，主要用于手写 API 文档费时费力，格式不统一；前后端接口对接时，文档经常滞后于代码；
核心要点
- 不同项目文档风格不一致，维护成本高；
- Swagger/OpenAPI 写起来复杂，容易出错；
- 写好一个 Flask/Django/FastAPI 接口，直接生成完整 API 文档；
使用与执行
根据代码注释自动推断参数类型和返回值；导出 OpenAPI 3.0 (Swagger)。它将相关步骤、工具调用和结果整理方式集中到统一流程中，帮助使用者更快完成目标并减少重复操作。从功能定位来看，该技能强调把分散的操作要求整理成清晰、可复用的处理流程，使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数，再依据技能说明逐步执行；
结果检查与注意事项
若输入条件不完整，应先补齐信息或采用保守配置，避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期，并对异常提示、缺失字段和边界情况进行处理；涉及批量任务时，还应保存进度，避免中断后重复操作。该技能适合用于一次性任务，也可以接入自动化工作流，与其他技能或上层代理配合完成更完整的业务链路；在组合使用时，应明确每一步的输入输出关系，并避免不同步骤之间出现参数冲突。
api-doc-gen — API 文档自动生成器
痛点
- 手写 API 文档费时费力，格式不统一
- 前后端接口对接时，文档经常滞后于代码
- 不同项目文档风格不一致，维护成本高
- Swagger/OpenAPI 写起来复杂，容易出错
场景
- 写好一个 Flask/Django/FastAPI 接口，直接生成完整 API 文档
- 根据代码注释自动推断参数类型和返回值
- 导出 OpenAPI 3.0 (Swagger) JSON/YAML 格式
- 导出 Markdown 格式给非技术团队查看
- 导出 Postman Collection 方便调试
定价
- 免费：基础文档生成（Markdown 格式，单文件）
- Pro 19元：OpenAPI 3.0 + Postman Collection + 多端点支持
- Team 49元：批量处理 + HTML 文档站 + 自定义模板
支持框架
- FastAPI
- Flask
- Django DRF
- Express.js
- 通用函数/类（基于注释推断）
输出格式
--format markdown— Markdown 格式 API 文档--format openapi— OpenAPI 3.0 JSON--format openapi-yaml— OpenAPI 3.0 YAML--format postman— Postman Collection JSON
指令格式
基本用法
api-doc-gen analyze[选项]
示例
# 分析 Python Flask 文件 api-doc-gen analyze app.py --framework flask --format markdown # 分析 FastAPI 代码 api-doc-gen analyze main.py --framework fastapi --format openapi # 分析 Express.js 文件 api-doc-gen analyze routes.js --framework express --format postman # 从代码字符串生成 api-doc-gen analyze "def hello(name: str) -> str: ..." --language python --format markdown # 批量处理目录 api-doc-gen batch ./api/ --framework fastapi --format openapi -o docs/
字段推断规则
基于 Python type hints / JSDoc / 代码注释自动推断：
- 参数类型：string, integer, number, boolean, array, object
- 是否必填：默认必填，有默认值则可选
- 描述：优先使用注释，其次参数名
- 格式：email, phone, url, date, datetime 等
内置响应模板
| 场景 | 状态码 | 响应结构 |
|---|---|---|
| 成功 | 200 | {code: 0, data: {}, message: "success"} |
| 创建成功 | 201 | {code: 0, data: {id}, message: "created"} |
| 参数错误 | 400 | {code: 400, data: null, message: "参数错误"} |
| 未授权 | 401 | {code: 401, data: null, message: "未授权"} |
| 服务器错误 | 500 | {code: 500, data: null, message: "服务器错误"} |
技术细节
- 语言：Python 3.8+
- 依赖：仅标准库（无外部依赖）
- 安装：pip install -r requirements.txt
- CLI：基于 argparse
相关专题
本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集，涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案，助你快速定位并解决Uvicorn运行中的各类问题。
2026.11.02
0
14
本专题汇总了Uvicorn使用教程与启动运行指南，涵盖其作为Python ASGI服务器的定位与特点，以及命令行启动（uvicorn main:app --reload）、参数配置（host/port/workers）、程序内嵌运行与Gunicorn结合部署等核心用法。同时整理了热重载调试、日志配置与生产环境部署优化等技巧，助你快速掌握Uvicorn的运行与配置。
2026.11.02
0
17
本专题汇总了Uvicorn的安装配置教程与部署指南，涵盖通过pip安装Uvicorn、启动FastAPI/Starlette应用、开发模式热重载（--reload）及多进程工作模式配置等核心操作。同时整理了结合Gunicorn的生产部署方案、HTTPS与反向代理配置及性能调优技巧，助你快速完成Uvicorn服务的安装与上线部署。
2026.11.02
0
17
Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章，帮助读者完成上线流程。
2026.10.28
0
16
Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章，帮助读者完成从初始化到日常开发的配置。
2026.10.28
0
15
Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章，帮助读者理解各文件夹的用途与引用方式。
2026.10.28
0
10
本专题介绍Gradle插件开发的基本流程，涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法，帮助你理解插件如何组织构建逻辑，减少多个项目之间的重复配置。
2026.10.22
0
11
本专题介绍Gradle Wrapper的基本作用，涵盖文件组成、生成方法、版本配置和任务调用，帮助你理解项目如何使用指定的Gradle版本，减少不同开发环境带来的构建差异。
2026.10.22
0
10
本专题整理Golangci-lint常用Linters的用途与配置方法，覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查，帮助项目合理选规则。
2026.10.22
0
15
热门下载
相关下载
精品课程
共6课时 | 54.7万人学习
共89课时 | 134.1万人学习
共49课时 | 82.6万人学习
最新文章