Skip to content
Sir, Post

Publish API docs

Write docs, save examples, share a public link and let others fork. · 4 min read

Write docs

Every collection, folder and request has a Docs section. Write in Markdown and switch to Preview to check it.

Writing docs for a request
Writing docs for a request

Save examples

After you send a request, click Save example in the response panel. Examples appear in the docs next to the request.

Code samples

Click Code on any request to copy it as cURL, JavaScript, Python or PHP.

Code samples for a request
Code samples for a request

Publish a public link

  1. Open the workspace's Docs tab.
  2. Pick a collection, choose which environment fills the variables, and click Publish.
  3. Click Copy public link and share it.

The Docs tab with a published collection
The Docs tab with a published collection

The public page is read-only and updates live when the collection changes. Authorization secrets and credential-looking headers are hidden, unless they are only a {{variable}}.

A public docs page
A public docs page

Click Unpublish at any time to turn the link off.

Fork

Anyone with a Sir, Post account can Fork a collection from a public docs page, or from a workspace they can view, into their own workspace and change it freely. Secrets never travel with a fork.

Forking a collection
Forking a collection

Did this help? If not, ask us.

Next: Backup and restore →