Design API specifications in Postman

Spec Hub is available with Postman Enterprise plans.

Take an API-first approach to development with Spec Hub in Postman. You can create OpenAPI 3.0 or AsyncAPI 2.0 specifications, and you can import existing OpenAPI 3.0 and AsyncAPI 2.0 specifications into Spec Hub. Navigate using the outline view, and add new sections with snippets. Tools such as autocomplete, syntax checking, and live documentation preview help you as you work.

When you're ready to share your API, use Spec Hub to generate a Postman Collection from your API specification. You can keep the generated collection in sync with an OpenAPI 3.0 specification. Team members and consumers can use these collections to explore or test your API.

Create or import a specification

You can create OpenAPI 3.0 or AsyncAPI 2.0 specifications in Spec Hub. You can also import a specification from your computer or a repository to continue building it out in Spec Hub.

Make sure you show specifications in the Postman sidebar. Specifications aren't visible by default.

Edit your specification by adding new sections with pre-formatted snippets or generating a schema from a JSON body. As you build out your specification, Postman offers autocomplete suggestions and identifies syntax errors. Postman also displays a live preview of your API's documentation to help you visualize your changes.

Generate a collection from a specification

Once you've designed and tested your API's structure in a specification, automatically generate a collection to share with your team members and consumers. Types is turned on for the generated collection. Generate a collection from your API specification to create a collection with folders, requests, and response examples based on the specification.

You can keep a collection in sync with its specification if it was generated from an OpenAPI 3.0 specification. When you make changes to the OpenAPI 3.0 specification, update the generated collection with your latest changes. This ensures team members and consumers can explore and test the latest iteration of your API.

Learn how to generate a collection from a specification and keep them in sync.