Skip to content

Tutorial: Import an OpenAPI spec

Time: ~10 minutes · Level: Intermediate

Before you start

  • A small OpenAPI 3 or Swagger 2 JSON file (your own or a sample from your API docs)

Steps

  1. In the sidebar, click Import (or run Gud API: Import Collection).
  2. Choose your JSON file.
  3. Wait for import to finish; open Collections and find folders created from tags or paths.
  4. Click a generated request to load it.
  5. Fix base URL if needed using environments ().

Checklist

  • [ ] Folders reflect tags or path grouping
  • [ ] At least one request has method + path prefilled
  • [ ] Variables from the spec appear where expected

Related: Import & export