Import OpenAPI/Swagger Data

POST

/v1/projects/{projectId}/import-openapi

Function Description

Currently supports importing data in OpenAPI 3, Swagger 2 formats.

The extensions have been added on top of standard Swagger/OpenAPI

Please check here to know more about Apidog OpenAPI Specification Extensions.

Request Example

Shell

JavaScript

Java

Swift

cURL

URLString

curl --location -g --request POST 'https://api.apidog.com/v1/projects/{{projectId}}/import-openapi?locale=en-US' \
--header 'X-Apidog-Api-Version;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "url": "https://petstore.swagger.io/v2/swagger.json"
    },
    "options": {
        "targetEndpointFolderId": 0,
        "targetSchemaFolderId": 0,
        "endpointOverwriteBehavior": "OVERWRITE_EXISTING",
        "schemaOverwriteBehavior": "OVERWRITE_EXISTING",
        "updateFolderOfChangedEndpoint": false,
        "prependBasePath": false
    }
}'

Response Example

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

Request

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Modified at 2025-03-11 07:39:30

Authentication

Import Postman Collection Data

Import OpenAPI/Swagger Data

Function Description#

Request

Responses

Function Description