Import and Discover Endpoints

Overview

Endpoint import and discovery keeps your project aligned with the API contract. Instead of creating endpoints one at a time, you import from an API specification — by Upload File or Use URL — and Studio derives features and endpoints automatically. See schema-aware test generation.

You can import at the project level (endpoints land under features derived from the spec's tags) or into a specific feature. The importer accepts OpenAPI/Swagger, WSDL (SOAP), GraphQL SDL, and Postman collections, and can auto-detect the type.

Before you begin

• You need a project. If none exists yet, create one first — the importer shows "Project Required: Please select or create a project first." without one.
• Navigation path: in the left sidebar, click the Endpoints button (the document-plus icon) to open the Import API to Project modal. If a feature is selected, the modal title reads Import API to Feature and endpoints are added to that feature.
• Have your spec ready as a file (.json, .yaml/.yml, .wsdl, .graphql/.gql) or a reachable URL.

Step 1 — Open the import modal

1. In the sidebar, click Endpoints (document-plus icon). The Import API to Project modal opens.
2. If you want endpoints attached to one feature, select that feature first so the modal opens as Import API to Feature.

Step 2 — Choose the API type

At the top of the modal, set the API Type dropdown:

• Leave it on Auto-Detect to let Studio infer the format from the file name or URL.
• Or pick a specific type (REST, SOAP, GraphQL, etc.). The modal shows the supported file extensions for the chosen type, and switches the import method if a type only supports one (for example, some types are URL-only).

Step 3 — Import via Upload File or Use URL

Pick a method with the Import Method buttons:

Upload File

1. Click Upload File.
2. Drag a spec onto the drop zone or click to browse. The accepted extensions follow the selected API type (OpenAPI/Swagger, WSDL, GraphQL SDL, or Postman collection).
3. The selected file's name and size appear; use Remove file to clear it.
4. Click Import File. A progress bar tracks the import.

Use URL

1. Click Import from URL.
2. Paste the API Specification URL (e.g. https://example.com/api-docs.json, a .wsdl, or a .graphql schema). The placeholder adapts to the selected type.
3. Click Import from URL. A progress bar tracks the import.

On success you'll see "API specification imported successfully! Features and endpoints have been created." If a Postman collection includes test scripts, a summary reports how many tests were created/updated and how many assertions need review.

Note: if the spec differs from endpoints already in the project, the importer routes you through change review instead — see API change detection.

Step 4 — Generate tests from requirements too

Beyond the API spec, you can drive generation from your requirements and backlog. Upload business/requirement documents (BRD, PRD) or import user stories from Jira, Azure DevOps, Gherkin feature files, or plain text, and Studio turns both spec and requirements into a traceable set of tests. See Requirements Intelligence and requirements extraction.

Step 5 — Verify the discovery output

Review the imported output before moving on to testing:

• Confirm the endpoint count per feature.
• Confirm HTTP methods (GET, POST, PUT, DELETE, etc.).
• Confirm expected endpoint paths and descriptions.

Then continue to Endpoint management to select an endpoint and open its test-case screen.

Step 6 — Keep endpoints in sync as the API evolves

As APIs change, re-import or run change detection to catch new, removed, modified, or breaking endpoints — then review and version them. The full diff/approve/version flow is covered in API change detection.

Troubleshooting / Notes

• "Project Required" — select or create a project before importing.
• "Auto-Detect couldn't determine the API type" — pick a specific API Type (REST / SOAP / GraphQL) and retry.
• "Couldn't import as <type>" — the chosen type doesn't match the content; switch API Type back to Auto-Detect and retry.
• File upload (or URL) is unavailable for a type — some types support only one method; the modal switches you to the supported one automatically.
• Import routed you into change review — the spec differs from existing endpoints; approve or reject the diff (see API change detection).
• Treat your spec as the source of truth, review diffs after each import, and validate critical endpoints first.

Related articles

• API change detection
• Understanding Rule Intelligence
• Endpoint management
• Validate endpoints