Include easy to browse API documentation into your help center.

API documentation will help developers learn about your API’s functionality and help them adopt it for their purposes.

If you include API documentation directly in your Viewport help center along with any other product documentation, it will be more easier to find and go back to when needed.

As reference material, it’s okay if the pages of your API documentation are longer than other types of content. However, browsability is key. Your users will probably want to skim through the pages, so you want to make sure that they can easily get to the piece of information they need.

Live Demo

Anatomy of the Page

Child pages

Having a page for each operation, for example will make it easier for users to overview the available content right away.

Table of Contents

Allow your users to jump to the relevant sections.

Code Snippet

Insert code into a code container with numbered lines, syntax highlighting and a 'copy code' option.

How To Construct the Page

Learn how to re-create the page using the Confluence editor.

Note: The easiest way to insert editor elements and macros is by typing / followed by the macro name right into the page.

  1. Create one page per operation

  2. On each page, add a heading 1 or 2 (/heading 2) to start your first section

  3. Describe the operation and purpose of the operation as normal text

  4. Add a code snippet macro (/Code snippet) to your page

  5. Set the language of your code snippet

  6. Add bullet points, tables (/table) to organize any other content

  7. Add more headings to your page. All headings will automatically show in Viewport as part of your table of contents.