Apifox 开放 API目录
导入数据（支持 Swagger/OpenAPI 格式）
Powered by Apifox
导入数据（支持 Swagger/OpenAPI 格式）
/api/v1/projects/{projectId}/import-data
功能说明
当前支持导入 OpenAPI 3、Swagger 1、2、3 格式数据。
调用接口需要个人访问令牌，查看如何获取个人访问令牌
Swagger 扩展支持
在标准的 Swagger/OpenAPI 基础上增加了如下扩展
一、指定某个接口所属目录：x-apifox-folder
多级目录使用斜杠/分隔。其中\和/为特殊字符，需要转义，\/表示字符/，\\表示字符\。
"paths": {
"/pets": {
"post": {
...
"operationId": "addPet",
"x-apifox-folder": "宠物店/宠物信息"
}
}
}
二、接口状态：x-apifox-status
| 状态 | 英文 |
|---|---|
| 设计中 | designing |
| 待确定 | pending |
| 开发中 | developing |
| 联调中 | integrating |
| 测试中 | testing |
| 已测完 | tested |
| 已发布 | released |
| 已废弃 | deprecated |
| 有异常 | exception |
| 已废弃 | obsolete |
| 将废弃 | deprecated |
"paths": {
"/pets": {
"post": {
...
"operationId": "addPet",
"x-apifox-status": "released"
}
}
}
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
projectId | path | string | 是 | 示例值： 2343199 项目 ID，打开 Apifox 进入项目里的“项目设置”查看 |
Body 参数(application/json)
数据结构
importFormat
string
导入数据格式
必需目前只支持openapi，表示 Swagger 或 OpenAPI 格式
枚举值:
openapi
data
string
要导入的数据
必需Swagger（OpenAPI） 格式 json 字符串，支持 OpenAPI 3、Swagger 1、2、3 数据格式
apiOverwriteMode
string
覆盖模式
匹配到相同接口时的覆盖模式，不传表示覆盖
枚举值:
methodAndPathignoreboth
默认值:
methodAndPath
syncApiFolder
boolean
是否同步更新接口所在目录
默认值:
false
apiFolderId
number
导入到目标目录的ID
不传表示导入到根目录
importBasePath
boolean
是否在接口路径加上basePath
建议不传，即为 false，推荐将 BasePath 放到环境里的”前置 URL“里
默认值:
false
示例
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSON
数据结构
data
object {2}
导入结果
必需apiCollection
object {2}
导入接口情况
必需schemaCollection
object {2}
导入数据模型情况
必需success
boolean
接口状态
必需默认值:
true
示例