GenerateApiDocument

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-20 14:23:45

Download PDF

1. API Description

Domain name for API request: apigateway.tencentcloudapi.com.

This API is used to automatically generate API documents and SDKs. One document and one SDK will be generated for each environment under each service, respectively.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: GenerateApiDocument.
Version	Yes	String	Common parameter. The value used for this API: 2018-08-08.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
ServiceId	Yes	String	Unique service ID of the document to be created.
GenEnvironment	Yes	String	Environment of the service for which to create an SDK.
GenLanguage	Yes	String	Programming language of the SDK to be created. Currently, only Python and JavaScript are supported.

3. Output Parameters

Parameter Name	Type	Description
Result	DocumentSDK	API document and SDK link.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Downloading SDK and API documentation

Input Example

https://apigateway.tencentcloudapi.com/?Action=GenerateApiDocument
&ServiceId=service-ody35h5e
&GenEnvironment=release
&GenLanguage=Python
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "DocumentURL": "https://apigateway-document-sdk-xxxxx",
      "SdkURL": "https://apigateway-document-sdk-xxxxx"
    },
    "RequestId": "01c56ec2-6a40-46bc-bdf6-8b273d4bec93"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.GenerateApiDocumentError	Failed to generate the API documentation.
FailedOperation.ServiceNotExist	The service does not exist.
InvalidParameterValue.InvalidGenLanguage	The `GenLanguage` parameter value is incorrect.
InvalidParameterValue.NotInOptions	The parameter value is incorrect, as it is not an available option.

Recent Pages