导入到你自己的 Apifox 项目
目标:把 CokeAPI 完整文档(接口 + 文章 + 图片)上传到你的 Apifox,并发布公开文档站。
准备好的材料
| 材料 | 地址 |
|---|---|
| 上传包目录 | https://doc.cokeapi.com/apifox-upload/ |
| 上传包 zip | https://doc.cokeapi.com/apifox-upload.zip |
| OpenAPI(完整) | https://doc.cokeapi.com/apifox-upload/openapi.json |
| OpenAPI(精简核心) | https://doc.cokeapi.com/openapi.json |
| 导入说明 | https://doc.cokeapi.com/apifox-upload/IMPORT.md |
| 文档站(可先用) | https://doc.cokeapi.com/ |
本地路径:brand/apifox/apifox-upload/
步骤 1:新建项目
- 打开 Apifox → 登录
- 新建项目,名称
CokeAPI - 类型选 HTTP
步骤 2:导入接口
- 项目设置 → 导入数据 → OpenAPI / Swagger
- 选 URL 导入:
https://doc.cokeapi.com/apifox-upload/openapi.json
- 建议勾选「定时导入」,文档站更新后可同步
- 导入后检查左侧接口树与环境 Base URL:
https://www.cokeapi.com/v1
步骤 3:导入文章(Markdown)
- 下载 zip 并解压,或打开本地
brand/apifox/apifox-upload/markdown/ - 在 Apifox 按文件夹建目录(与 zip 内一致),例如:
- 00-CokeAPI官方指南
- 00-开始
- 中转站基本介绍
- 各种插件/软件使用教程
- …
- 每个
.md→ 新建 Markdown 文档 → 粘贴全文
图片已是 https://doc.cokeapi.com/images/...,在 Apifox 里可直接显示
- 建议先贴官方指南,再贴迁移教程
步骤 4:发布
- Apifox → 分享 / 发布文档
- 得到
https://xxxx.apifox.cn/ - 把链接发给运维,可将站点导航「文档」切到该地址
步骤 5:调试环境(可选)
| 变量 | 值 |
|---|---|
baseUrl | https://www.cokeapi.com/v1 |
apiKey | sk-你的令牌 |
请求头:Authorization: Bearer {{apiKey}}
注意
- 接口目录里的路径,并不等于站点已全部开通;可用模型见 https://www.cokeapi.com/pricing
- 若你有 Apifox Access Token,可交给同事用 CLI 自动导入 OpenAPI