Import from a HAR capture or an OpenAPI address
What each import keeps, the limits on fetching a document, and what to do when it fails.
In short
A HAR capture is what your browser's Network panel saves; an OpenAPI or Swagger document describes an API. Both can be imported into a project as requests. A HAR import keeps only the API calls and leaves credentials behind.
Before you start
- Who: signed in with API Tester on. Importing into an existing project needs Edit on it.
- Plan: a new project counts toward your plan's project limit.
- First: save the HAR file (at most 10 MB), or copy the OpenAPI address or download the file.
Steps
- In your browser's Network panel, do the actions you want, then choose Save all as HAR. For OpenAPI, copy the document's address or download the file.
- Paste the address or drop the file into the search box (Ctrl+K), or use the "Import / Export center".
- Read the preview and import. See /help/api-testing/paste-to-import for the steps.
Result: a project with one request per API call or operation.
Good to know
- Kept from a HAR: calls that answered JSON or XML, addresses under /api/, and every call other than a plain GET. Pages, scripts, styles, images, fonts and preflight checks are left out; the preview says how many.
- Calls to the same address shape (/orders/41 and /orders/42) are imported once, named like GET /api/orders/{id}, and grouped by the first part of the address that names something.
- The server fetches an address, not your browser, and only if it is allowed. It must be http or https, with no password in it. It must not be on the server's own network unless your deployment allows that. The answer may be at most 10 MB and must come within 20 seconds. Every redirect is checked the same way.
- The answer must be an OpenAPI 3 or Swagger 2 document in JSON or YAML. Each person can fetch ten documents a minute.
Credentials do not come along Cookies, Authorization headers and browser-only headers are dropped. A token in an address or a password in a body becomes a placeholder to fill in, listed in the preview. Check the requests before you share the project: a capture can hold personal data in ordinary fields.
If something goes wrong
Related
- /help/api-testing/paste-to-import
- /help/api-testing/openapi-postman-conversion
- /help/api-testing/import-export-packages