GeneratorsPostman

Publishing to Postman

Publish your Postman collection directly to Postman workspaces, making it easy for your team and API consumers to discover and test your endpoints.

Publish directly to Postman

To publish your collection directly to Postman, configure the output and specify the name of your collection:

generators.yml
1groups:
2  postman:
3    generators:
4      - name: fernapi/fern-postman
5        version: 0.4.0
6        output:
7          location: postman
8          api-key: ${POSTMAN_API_KEY}
9          workspace-id: 07e228e5-3f91-4223-8e27-bbfe4a81a601
10        config:
11          collection-name: My collection name

Publish to a collection

To publish to a particular collection, configure the output and specify the name of your collection and collection ID:

generators.yml
1groups:
2  postman:
3    generators:
4      - name: fernapi/fern-postman
5        version: 0.4.0
6        output:
7          location: postman
8          api-key: ${POSTMAN_API_KEY}
9          workspace-id: 07e228e5-3f91-4223-8e27-bbfe4a81a601
10          collection-id: 21510182-14b07230-46e2-431e-8153-d5c7d217b214
11        config:
12          collection-name: My collection name