tencent cloud

Feedback

API Doc Generator

Last updated: 2022-04-02 14:32:50

    Overview

    You can use the API Doc Generator to generate exquisite API documents for APIs hosted in API Gateway and provide them to third-party callers of your APIs.

    Note:

    The API Doc Generator is completely free of charge with technical support provided by CODING DevOps. Click here to learn more about the capabilities of CODING.

    Prerequisites

    You have created a service and an API in API Gateway (as instructed in Creating Services and API Creation Overview) and released the service to any environment (as instructed in Service Release and Deactivation).

    Directions

    Creating documents

    1. Log in to the API Gateway console and click Tool > API Doc Generator in the left sidebar.
    2. On the API Doc Generator page, click Create now, enter the document name in the pop-up window, select the environment, service, and API, and click Submit.
    3. Wait patiently for the API document creation to complete.

    Viewing document details

    The following is the details page of an API document:

    Parameters are described in the following table.

    Parameter Description
    API document address The access address of the current API document.
    API document password The password of the current API document. API documents are encrypted by default and can be viewed only with the correct password.
    Shared link You can copy the link and share it with a third party.
    Update time Last time when the API document was updated.
    Service The service of the API for which the document is generated.
    Environment The environment where the service is released, which can be used to generate the API call address.
    API The API contained in the current API document.

    Accessing documents

    1. Copy the API document address and paste it in a browser to open the document login page.
    2. Enter the API document password on the document login page to view the content of the document.

    Updating documents

    After editing the API for which an API document is generated, the document will not be updated synchronously. Using the "document update" feature can ensure that the API document is consistent with the API information. The steps are as follows:

    1. Click Update in the top-right corner of the document details page.
    2. Click Confirm in the pop-up window and wait for the document construction to complete.

    Resetting the password

    After you reset the API document password, a new password will be generated. Users can only use the new password to access the document, while the old password will not work. The steps are as follows:

    1. Click Reset after the API document password.
    2. Click Confirm in the pop-up window to generate a new API document password.

    Deleting documents

    1. Click Delete in the top-right corner of the document details page.
    2. Click Confirm in the pop-up window to delete the API document.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support