Import OpenAPI Spec

Apidog supports importing JSON or YAML files in OpenAPI 3.0, OpenAPI 3.1, and Swagger 2.0 formats. Support also includes standard Serialization Extensions.

When importing or exporting OpenAPI/Swagger data, Apidog supports object-type parameters and reference-type parameters.

Choose the Project mode before importing

When creating a new target Project, choose General Mode or Spec-first Mode before creation. Project mode cannot be switched after the Project is created.

Configuration & Scheduling

For detailed configuration settings (Conflict Resolution, Folder Sync, etc.) and automation instructions, please refer to the dedicated guides:

Import Options: Comprehensive guide on all available settings during import.

Scheduled Import: How to set up automatic synchronization.

URL Import Tips

When importing via URL, ensure you provide the direct URL to the JSON or YAML data file.

❌ Incorrect: https://petstore.swagger.io/ (The Swagger UI Dashboard)
✅ Correct: https://petstore.swagger.io/v2/swagger.json (The Raw Data File)

If Apidog reports that the file cannot be parsed in the selected format, check that you selected the correct OpenAPI/Swagger import format and that the URL points to the raw specification file.

(Optional) Basic Auth: If your OAS file URL is protected behind Basic Auth, toggle the switch and enter credentials during import.

Configuration & Scheduling#

URL Import Tips#

Configuration & Scheduling

URL Import Tips