Viewing API Documentation
Apidog's published API documentation provides an interactive, comprehensive view of your APIs. When users access your documentation URL, they'll see a well-structured presentation of each endpoint with multiple sections designed for easy understanding and testing.Documentation Structure#
Each endpoint page includes the following sections:Metadata: Basic endpoint information
Try it out: Interactive API testing
Request: Parameters and body specifications
Request samples: Code examples in various languages
Responses: Response specifications and examples
Endpoint Status#
Endpoints with "Released" status won't show a status tag. Endpoints with other statuses (like "Developing") will display a status tag after the endpoint name. Endpoints with "Deprecated" status appear as "endpoint name" in the left directory tree.Endpoint Description#
Markdown content in the endpoint description is rendered and displayed at the end of the metadata section.Try It Out#
Click "Try it out" to expand the interactive testing layer where you can send requests, modify parameters, and switch environments. Available environments are those selected when creating the documentation.If you select the Cloud mock environment when creating the documentation, you're providing readers with a simple sandbox environment for testing APIs. Using Variables#
If {{variables}} are used in request examples, readers must set variable values before sending requests.Using Credentials#
You can configure authentication at the API or folder level within your project's Auth settings. Use security schemes or define settings manually.After configuring the authentication settings—for example, using Bearer Token authentication—you will see an "Credentials" section at the top of the "Publish Documentation" panel, where you can directly enter the token value.The major benefit of this configuration approach is that authentication information can be shared across different APIs. If multiple APIs reference the same security scheme or authentication type, you only need to enter the authentication information once, and other APIs can automatically reuse it.These credentials are encrypted and stored in the browser's LocalStorage, and are managed based on the browser session. Within the same session, they can be shared across multiple windows and tabs. Once the browser is closed and the session ends, these credentials automatically become invalid.More specifically: the credentials stored in LocalStorage are encrypted, while the decryption key is stored in a session cookie. Although the data in LocalStorage persists long-term, the decryption key in the session cookie expires as soon as the browser is closed. As a result, the encrypted data can no longer be decrypted or accessed, and you'll need to re-enter the credentials the next time you visit.Request#
This section displays parameters and body specifications. Apidog supports two parameter display styles—Modern or Classic—which you can choose in Settings → Feature Settings → Endpoint Feature Settings.Request Samples#
Request code samples in various programming languages. You can choose whether to display this module when creating the share.Responses#
Response specifications and examples, displayed the same as in the Apidog client.Export#
If you selected "Allow exporting data" when creating the documentation, readers will see an Export option in the bottom right corner and at the very bottom of the document.Readers can choose between "Clone" or "Export". "Export" supports exporting in OAS, HTML, Markdown, and Apidog formats. Modified at 2026-01-21 04:09:01
