Import an API specification

Spec Hub is available with Postman Enterprise plans.

You can import an existing OpenAPI 3.0 or AsyncAPI 2.0 specification in Spec Hub. Import an OpenAPI 3.0 specification as a collection or a specification and collection you can keep in sync. Import an AsyncAPI 2.0 specification as a specification in Spec Hub only.

You can't import a multi-file specification into Spec Hub. If you select Import in the sidebar, importing a multi-file specification only gives you the option to import into the API Builder.

1. Select Import in the sidebar.

2. Choose one of the following options to import a specification file:

   • Select files, then select a specification file.

   • Enter a link to a specification file.

   • Paste raw text.

   • Import from a remote GitHub, Bitbucket, GitLab, or Azure DevOps repository. Select Other Sources, and then select GitHub, Bitbucket, GitLab, or Azure.

     Follow the instructions to sign in to your repository. Then select the repository and other relevant details and select the branch you want to import from.

3. Choose how you'd like to import the specification file into Postman:

   • Postman Collection - (OpenAPI 3.0 specs only) Generates a collection with folders, requests, and response examples based on the specification. A new specification isn't created in Spec Hub.
   • OpenAPI 3.0 Specification with a Postman Collection - (OpenAPI 3.0 specs only) Generates a collection from the specification and creates a new specification in Spec Hub. If you update the specification, you can update the collection with the latest changes to the specification. Learn more about keeping OpenAPI collections in sync with a specification.
   • AsyncAPI 2 Specification - (AsyncAPI 2.0 specs only) Creates a new specification in Spec Hub.

   For OpenAPI specifications, you can select View Import Settings for more configuration options. These options will vary depending on your specification.

4. Select Import.

5. In the Importing message that displays in the Postman footer, select Go to Specification next to a specification or Go to Collection next to a collection.

Postman stores your authorized accounts so you can use them to connect to other repositories and services. Learn more about managing connected accounts for remote repositories.