GenerateApiDocument
最近更新时间: 2025-10-20 17:06:00
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（GenerateApiDocument）用于自动生成 API 文档和 SDK，一个服务的一个环境生成一份文档和 SDK。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-11-24 15:15:09。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：GenerateApiDocument |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ServiceId | 是 | 否 | String | 待创建文档的服务唯一 ID。 |
| GenEnvironment | 是 | 否 | String | 待创建 SDK 的服务所在环境。 |
| GenLanguage | 是 | 否 | String | 待创建 SDK 的语言。当前只支持 Python 和 JavaScript。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DocumentSDK | api文档&sdk链接。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ServiceNotExist | 服务不存在。 |
| InvalidParameterValue.NotInOptions | 参数取值错误。当前值不在可选范围内。 |
| FailedOperation.GenerateApiDocumentError | API文档生成失败。 |
| InvalidParameterValue.InvalidGenLanguage | 参数GenLanguage取值错误。 |