[!info] related notes

• 所属 MOC: 后端开发 MOC
• 前置概念: Open API Swagger, 接口规范
• 相关资源: APIFox, postman, postman-vs-apifox

从项目中导入swagger文档

[!warning] needs-human-review 本文保留原项目操作记录，但尚未确认所属仓库与版本。pnpm dev:api、3888 端口和 src/scripts/export-api-docs.js 不是通用 Apifox 配置；执行前需在原项目核实，暂不计为完成语义 review。

问题详情

希望把项目中的 api 接口都放到 apifox 中

解决方案

方法一：通过 OpenAPI 文档导入（推荐）

步骤：

1. 启动 API 服务器：pnpm dev:api
2. 访问 API 文档：http://localhost:3888/api-docs
3. 获取 OpenAPI JSON：http://localhost:3888/api-docs.json
4. 在 Apifox 中选择”导入” → “OpenAPI/Swagger”
5. 粘贴 JSON 内容或上传文件

自动化导出：

运行以下命令生成文档文件：

cd apps/api

node src/scripts/export-api-docs.js

方法二：通过 URL 同步导入

步骤：

1. 在 Apifox 中选择”导入” → “URL 导入”
2. 输入：http://localhost:3888/api-docs.json
3. 选择”定时同步”以保持文档更新

方法三：手动创建接口

适用场景：

• 需要精确控制接口文档
• 添加自定义测试用例
• 特殊的业务逻辑说明

实战经验

经验总结

信息参考