Import an API specification

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.

Postman only supports importing a single OpenAPI 3.0 or AsyncAPI 2.0 specification file into Spec Hub. If you try to import an unsupported specification using Import in the sidebar, Postman only gives you the option to import into the API Builder. Examples of unsupported specifications include multi-file specifications and unsupported formats, such as GraphQL or OpenAPI 3.1.

1. Select Import in the sidebar.

2. Choose one of the following options to import an OpenAPI 3.0 or AsyncAPI 2.0 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. If you're importing an OpenAPI 3.0 specification, choose how you'd like to import it into Postman, then select Import:

   • Postman Collection - 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 - 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.

   You can also select View Import Settings for more configuration options. These options will vary depending on your specification.

   AsyncAPI 2.0 specifications are automatically imported as a new specification in Spec Hub.

4. 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.

Your Postman plan gives you a limited number of specifications in your team's internal workspaces. Learn more about resource usage in Postman.

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.