导入 OpenAPI/Swagger 格式数据
POST/v1/projects/{projectId}/import-openapi请求参数
Path 参数
projectId
string
必需
示例值:
{{projectId}}
Query 参数
locale
string
可选
示例值:
zh-CN
Body 参数application/json
input
必需
需要导入的 OpenAPI 数据，支持字符串或者 URL 方式导入。
One of
URL 方式导入，包含必填的url参数和可选basicAuth参数。
url
string
必需
用来获取 OpenAPI 格式数据的 URL 地址
basicAuth
object
鉴权信息
如果使用 URL 方式导入，且访问该 URL 需要鉴权时，需要填写鉴权的用户名和密码
options
object
可选
包含高级选项及其值的导入过程对象。
targetEndpointFolderId
number
可选
用于存储或匹配 API 接口的目标目录的 ID。如果未指定，目标目录将为 Root 目录。
targetSchemaFolderId
number
可选
用于存储或匹配数据模型的目标目录的 ID。如果未指定，目标目录将为 Root 目录。
endpointOverwriteBehavior
enum<string>
可选
指定处理匹配的接口的行为。确定是否覆盖现有的接口，自动合并更改，跳过更改并保留现有的接口，或创建新的接口。
枚举值:
OVERWRITE_EXISTINGAUTO_MERGEKEEP_EXISTINGCREATE_NEW
默认值:
OVERWRITE_EXISTING
schemaOverwriteBehavior
enum<string>
可选
指定处理匹配的数据模型的行为。确定是否覆盖现有的模式，自动合并更改，跳过更改并保留现有的模式，或创建新的模式。
枚举值:
OVERWRITE_EXISTINGAUTO_MERGEKEEP_EXISTINGCREATE_NEW
默认值:
OVERWRITE_EXISTING
updateFolderOfChangedEndpoint
boolean
可选
在导入匹配的现有接口时，是否更新接口的目录 ID。如果希望随导入的接口一起更改目录 ID，则应将其设置为 true。
默认值:
false
prependBasePath
boolean
可选
是否将基础路径添加到接口的路径中，默认设置为 false。我们建议将其设置为 false，这样基础路径可以保留在“环境面板”中，而不是每个接口内部。如果希望在接口路径中添加路径前缀，则应将其设置为 true。
默认值:
false
示例
{
"input": {
"url": "https://petstore.swagger.io/v2/swagger.json"
},
"options": {
"targetEndpointFolderId": 76,
"targetSchemaFolderId": 60,
"endpointOverwriteBehavior": "OVERWRITE_EXISTING",
"schemaOverwriteBehavior": "KEEP_EXISTING",
"updateFolderOfChangedEndpoint": true,
"prependBasePath": true
}
}示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
data
object
导入结果
counters
object
导入的接口情况统计
errors
array [object {2}]
可选
示例
成功示例
{
"data": {
"counters": {
"endpointCreated": 10,
"endpointUpdated": 0,
"endpointFailed": 0,
"endpointIgnored": 0,
"schemaCreated": 10,
"schemaUpdated": 0,
"schemaFailed": 0,
"schemaIgnored": 0,
"endpointFolderCreated": 0,
"endpointFolderUpdated": 0,
"endpointFolderFailed": 0,
"endpointFolderIgnored": 0,
"schemaFolderCreated": 0,
"schemaFolderUpdated": 0,
"schemaFolderFailed": 0,
"schemaFolderIgnored": 0
}
}
}最后修改时间： 23 天前