Opening the copied URL in a browser will show you Apidog's online API documentation.
Each endpoint is displayed as a page, including several sections:This section displays various basic information about the endpoint, such as URL, method, modification time, description, etc. You can choose which fields to display when creating the documentation.Endpoint status
Endpoints with "Released" status won't show a status tag; endpoints with other status (like "Developing") will display a status tag after the endpoint name. Endpoints with "Deprecated" status will be shown as "endpoint name" in the left directory tree.
Endpoint description
The Markdown in the endpoint description will be displayed at the end of the metadata.
Try it out#
Clicking it will expand the Try it out layer, where you can send requests or modify parameters, and switch the environment for the request. The available environments here are those selected when creating the documentation.If you select the Cloud mock environment when creating the documentation, it's equivalent to enabling a simple sandbox environment for the readers of the documentation.
Use variables#
If {{variables}} are used in request examples of the spec, when using the "try it out" feature, readers need to first set the values for these variables before they can send the request.Use credentials#
You can configure authentication at the API or folder level within your project's Auth settings. You may use the security schemes, or define the 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#
Parameters and body Specification. Apidog supports two parameter display styles, you can choose Modern or Classic style in Project Settings - feature settings - endpoint feature settings.Request samples#
Request samples in various languages. You can choose whether to display this module when creating the share.Responses#
Response spec and Response example, 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. 
