导入 Postman Collection 格式数据
POST
/v1/projects/{projectId}/import-postman-collection当前支持导入 Postman Collection v2 格式数据。
请求参数
Path 参数
projectId
string
必需
示例值:
{{projectId}}
Query 参数
locale
string
可选
示例值:
zh-CN
Body 参数application/json
input
string
必需
定义的字符串化 JSON 对象。
options
object
可选
包含高级选项及其值的用于导入过程的对象。
targetEndpointFolderId
number
可选
存储或匹配 API 接口的目标目录的 ID。如果未指定,目标目录将为 Root 目录
。
endpointOverwriteBehavior
string
可选
指定处理匹配的接口的行为,该接口由** HTTP 方法和路径**的组合匹配。它确定是覆盖现有接口,自动合并更改,跳过更改并保留现有接口,还是创建一个新接口。
枚举值:
OVERWRITE_EXISTINGAUTO_MERGEKEEP_EXISTINGCREATE_NEW
默认值:
OVERWRITE_EXISTING
endpointCaseOverwriteBehavior
string
可选
指定处理匹配的接口用例的行为。它确定是覆盖现有的接口用例,跳过更改并保留现有的接口用例,还是创建一个新的。
接口用例只有在同一接口内使用与现有接口用例名称相同的请求名称时才匹配。
枚举值:
OVERWRITE_EXISTINGKEEP_EXISTINGCREATE_NEW
默认值:
OVERWRITE_EXISTING
updateFolderOfChangedEndpoint
boolean
可选
在导入匹配的现有接口时,是否更新接口的目录 ID。如果要随导入的接口一起更改目录 ID,则应将其设置为 true。
默认值:
false
示例
{
"input": "string",
"options": {
"targetEndpointFolderId": 0,
"endpointOverwriteBehavior": "OVERWRITE_EXISTING",
"endpointCaseOverwriteBehavior": "OVERWRITE_EXISTING",
"updateFolderOfChangedEndpoint": false
}
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
data
object
导入结果
counters
object
导入的接口情况统计
errors
array [object {2}]
可选
示例
成功示例
{
"data": {
"counters": {
"endpointCreated": 10,
"endpointUpdated": 0,
"endpointFailed": 0,
"endpointIgnored": 0,
"endpointFolderCreated": 0,
"endpointFolderUpdated": 0,
"endpointFolderFailed": 0,
"endpointFolderIgnored": 0,
"endpointCaseCreated": 0,
"endpointCaseUpdated": 0,
"endpointCaseFailed": 0,
"endpointCaseIgnored": 0
}
}
}
修改于 3 个月前