Create a new API specification

Create a specification in Spec Hub to design and test your API's structure. You can create a specification in OpenAPI 3.0 or AsyncAPI 2.0 format. Then you can share your specification with collaborators.

You can also import an OpenAPI 3.0 or AsyncAPI 2.0 specification into Spec Hub.

Show specifications in the sidebar

By default, specifications aren't visible in the Postman sidebar. You can change this in your workspace settings.

1. Select the name of the current workspace in the sidebar, then click the Settings tab in the workbench.
2. Under Configure sidebar, turn on the toggle next to Specs.
3. Click Specs in the sidebar to view and work with specifications.

Create a new specification

You can create OpenAPI 3.0 and AsyncAPI 2.0 specifications in Spec Hub. You can also import an existing OpenAPI 3.0 or AsyncAPI 2.0 specification into Postman.

1. Click Specs in the sidebar.

2. Click Create new specification and select the type of specification you want to create (OpenAPI 3.0 or AsyncAPI 2.0). Postman creates a new specification with boilerplate content. Postman creates AsyncAPI 2.0 specifications with the WebSocket protocol.

   

3. To rename your specification, click View more actions next to the specification in the sidebar and select Rename. Type a new name and select Return or Enter.

   You can also rename the specification file. Select the filename in the workbench, enter a new name, and select Return or Enter.

4. Edit or replace the content in the specification as needed for your API. Learn more about editing your specification.

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

You can't change the specification type (OpenAPI 3.0 or AsyncAPI 2.0) after creating a specification. Create a new specification instead.

Share a specification

You can share a specification with collaborators. Click Specs in the sidebar and select a specification. Then click Copy link to file in the workbench.

For more details about sharing elements, see Share your work in Postman.

Rename a specification

1. Click Specs in the sidebar.
2. Next to your specification, select View more actions > Rename.
3. Enter a new name for your specification.
4. Select Return or Enter.

Delete a specification

1. Click Specs in the sidebar.
2. Next to your specification, select View more actions > Delete.
3. Click Delete to confirm.