从项目中导入swagger文档
将项目API接口导入Apifox(通过OpenAPI/Swagger文档)
#tech / dev / api
#type / howto
#status / evergreen
#resource / apifox
#media / tool
[!info] related notes
- 所属 MOC: 后端开发 MOC
- 前置概念: Open API Swagger, 接口规范
- 相关资源: APIFox, postman, postman-vs-apifox
从项目中导入swagger文档
问题详情
希望把项目中的 api 接口都放到 apifox 中
解决方案
方法一：通过 OpenAPI 文档导入（推荐）
步骤：
- 启动 API 服务器：
pnpm dev:api - 访问 API 文档：http://localhost:3888/api-docs
- 获取 OpenAPI JSON：http://localhost:3888/api-docs.json
- 在 Apifox 中选择”导入” → “OpenAPI/Swagger”
- 粘贴 JSON 内容或上传文件
自动化导出：
运行以下命令生成文档文件：
cd apps/api
node src/scripts/export-api-docs.js
方法二：通过 URL 同步导入
步骤：
- 在 Apifox 中选择”导入” → “URL 导入”
- 输入：
http://localhost:3888/api-docs.json - 选择”定时同步”以保持文档更新
方法三：手动创建接口
适用场景：
- 需要精确控制接口文档
- 添加自定义测试用例
- 特殊的业务逻辑说明