关于 API 文档生成器
该工具用于快速整理接口信息并导出文档，支持多端点管理、模板填充和多格式输出。
核心功能
- 基础信息管理：维护 API 名称、版本、基础地址与描述。
- 端点管理：添加路径、方法、参数、请求体与响应示例。
- 模板辅助：通过模板快速生成常见接口文档结构。
- 多格式导出：支持 Markdown、HTML、OpenAPI、cURL 风格输出。
- 复制与下载：可直接复制文档内容或下载文件。
使用说明
- 填写 API 基础信息。
- 添加并编辑一个或多个端点。
- 选择输出格式并预览生成结果。
- 复制或下载文档用于团队协作。
适用场景
- 新项目接口文档快速起稿。
- 历史项目文档补齐与标准化。
- 联调前向前后端共享统一接口说明。
常见问题
可以直接作为 OpenAPI 正式规范吗？
可作为基础草稿，建议在发布前结合项目规范做一次人工校验。
如何提高文档可读性？
建议补全字段含义、示例请求/响应以及错误码说明，避免仅保留结构。