Publishing to the API Network
Publishing your documentation to the API Network connects your API to the Postman community. You can publish docs to the network from any team collection. For individual collections that are not published via a team, you can instead add to the Postman templates.
For APIs that your team uses internally, you can add to the private API network.
Sharing your docs exposes your API to the millions of developers who use Postman, and lets others within the community learn from your projects. By publishing to the API Network, you share your API through a human-readable reference in the form of your docs—and an executable way to interact with your API endpoints inside Postman, via the embedded Run in Postman button.
Your docs can convey detailed guidance on how to make requests to your API endpoints, as well as the workflows required to integrate with your API in general. This provides the information—and actionable data—developers need to get started using your services.
When you add your API to the network it will be associated with your public team profile listing. You can set your profile up before publishing or Postman will generate one for you during publication and you can optionally customize it later.
To add an API to the network, you first need to document and publish a collection. You can share your docs to the API Network during the publishing process, by enabling Collection discovery and selecting Add to API Network.
If your collection is already published, you can make it discoverable by opening the published docs, opening the Published drop-down menu, and clicking Edit Published Documentation.
You can access your published docs from Postman (select the collection and click View in web), or from the web dashboard (navigate to Workspace > Collections and click the published collection title).
Click Allow Collection Discovery to set up your network listing.
Select Add to API Network.
Include the API Name, Summary, and Description—add the details potential users will need to know in order to find your API and figure out whether they want to use it. Your description can include markdown, and will automatically be populated from any description you already have included in your collection.
Select the categories that best describe your API and service. API consumers can choose categories to browse APIs in the network from the left sidebar in Postman and at explore.postman.com.
When you publish to the API Network, your API will be listed as part of your team profile. If you don't already have a team profile, Postman will automatically generate one when you publish. You can customize your profile at any time before or after publishing your API.
Use the Public Profile Settings link or navigate to your team profile settings to enable or customize the details consumers will see when your API is published and visible in the network.
Include a team name and description that will appear in your API Network listing. You can customize your profile URL, and add a logo and favicon in your Settings.
If you receive an error when uploading your favicon, confirm that it is a square .ico file and no larger than 500KB.
Once your team profile is set up any collection docs you publish will be associated with it. Click Publish Collection.
When people browse the API Network they will see your team profile listing, along with the APIs and templates you have published.
If you choose to disable your team profile, you won't be able to publish any new collections to the Postman API Network or templates, and any previously published collections will be unpublished.
You will see a link to your collection's published listing and team profile. You will also be able to find your listing in Postman using New > API Network or on the web.
Your team's API Network listing shows the number of imports for each of your APIs, with links to the documentation and Run in Postman button so that people can import your collection templates directly into Postman to begin using your endpoints straight away.
Clicking the title of an API in the web listing of your team profile will open the listing page for that particular collection, showing the description, publisher details, imports, and linking to the documentation alongside Run in Postman for importing the collection directly.
Check out some tips for making the most of your network listing.