Create a new API specification

Create a specification in Spec Hub to design and test your API’s structure. You can create specifications in OpenAPI, AsyncAPI, protobuf, GraphQL, and Smithy format, then share your specification with collaborators.

Create a new specification

You can create OpenAPI, AsyncAPI, protobuf, and GraphQL specifications in Spec Hub. You can also import an existing specification into Postman.

1. In the sidebar, click and select Spec.
2. Select the type of specification you want to create. Postman creates a new specification with boilerplate content.
3. To rename your specification, click More actions next to the specification in the sidebar and select Rename. Type a new name and press Return or Enter. Or, select the filename in the workbench, enter a new name, and press Return or Enter.
4. Edit or replace the content in the specification as needed for your API. Learn more about editing your specification.

Share a specification

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

Rename a specification

1. Expand Specs in the sidebar.
2. Next to your specification, select More actions > Rename.
3. Enter a new name for your specification.
4. Press Return or Enter.

Delete a specification

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

Comment on a specification

You can add one or more comments to a specification in Spec Hub. Use comments to discuss your specifications with collaborators in Postman, keeping the conversation in context and available to other stakeholders.

To add a comment to a specification, do the following:

1. Expand Specs in the sidebar, then select the specification that you want to comment on.
2. Click Comments in the right sidebar.
3. Enter your comment and click Comment.