Publish API documentations

Using Apidog Fast Request, you can leverage the power of Apidog to publish Stripe-like API documentations.

Generate API Access Token

Before using the Apidog Fast Request plugin to publish API documentations, you need to register an Apidog account and generate a API access token. For detailed instructions, please refer to Generate API Access Token.

In Apidog Fast Request, fill in your API access token, and then click "Test Token". If the test is successful, click "Apply" or "OK" button.

Upload endpoints to Apidog

Apidog Fast Request plugin supports uploading endpoints within the following scope:

• All endpoints in the module: Click the Apidog icon on the right panel, or right-click the module node in the left directory tree and select "Upload to Apidog"
• All endpoints in the controller: Inside the controller file, right-click and select "Upload to Apidog"

If this is your first time to uploading endpoints to Apidog, a pop-up will appear asking you to select the target project. You can select either a project or a folder within the project. Selecting the project will upload the endpoints to the project's root folder.

Schemas do not need to be configured. The API specification will be uploaded to the schema root folder of the project where the endpoints are located by default.

View API Documentation

Afterward, you can easily share the API documentation, allowing others to conveniently view it in a browser. For detailed instructions, please refer to Publish APIs.