Developers LinkApi

API Documentation

LinkApi will generate your API documentation automatically. On the Code Builder, in the action bar, select Commit and then Publish. In a few moments, your documentation will be published and can be accessed by anyone.

The documentation link inside the action bar.

The documentation link inside the action bar.

The link will be available in the action bar and within the API project list. Each project will have a separate documentation. When a project is edited and published, the API Documentation will be updated in a few moments.

"Invalid documentation" error message

If you have the "Invalid documentation" message, be sure to publish your project and wait a few moments.

API Documentation


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.