导入 OpenAPI/Swagger 格式数据

POST

https://api.apifox.com/v1/projects/{projectId}/import-openapi

功能说明

当前支持导入 OpenAPI 3、Swagger 2 格式数据。

详细说明请参考《Apifox Swagger 扩展》

请求参数

Path 参数

Query 参数

Header 参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

cURL

URLString

curl --location -g --request POST 'https://api.apifox.com/v1/projects/{{projectId}}/import-openapi?locale=zh-CN' \
--header 'X-Apifox-Api-Version: 2024-03-28' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "url": "https://petstore.swagger.io/v2/swagger.json"
    },
    "options": {
        "targetEndpointFolderId": 76,
        "targetSchemaFolderId": 60,
        "endpointOverwriteBehavior": "deleteUnmatchedResources",
        "schemaOverwriteBehavior": "KEEP_EXISTING",
        "updateFolderOfChangedEndpoint": true,
        "prependBasePath": true
    }
}'

响应示例

成功示例

{
    "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
        }
    }
}

修改于 2025-12-26 09:29:05

鉴权

导入 Postman Collection 格式数据

导入 OpenAPI/Swagger 格式数据

功能说明#

请求参数

返回响应

功能说明