导入OpenAPI

最近更新时间:2024-03-12 01:08:46

我的收藏

1. 接口描述

接口请求域名: apigateway.tencentcloudapi.com 。

本接口(ImportOpenApi)用于将OpenAPI规范定义的API导入到API网关。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ImportOpenApi。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
ServiceId String API所在的服务唯一ID。
示例值:service-xxx
Content String openAPI正文内容。
示例值:xxx
EncodeType String Content格式,只能是YAML或者JSON,默认是YAML。
示例值:YAML
ContentVersion String Content版本,默认是openAPI,目前只支持openAPI。
示例值:openAPI

3. 输出参数

参数名称 类型 描述
Result CreateApiRspSet 导入OpenApi返回参数。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 ImportOpenApi

输入示例

POST / HTTP/1.1
Host: apigateway.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImportOpenApi
<公共请求参数>

{
    "ServiceId": "service-xxxxx",
    "EncodeType": "YAML",
    "Content": "info:\n  title:test\n  version: 1.0.1\nopenapi: 3.0.0\npaths:\n  /:\n    get:\n      operationId: test\n      responses:\n        '200':\n          description: The list of possible responsesas they are returned from executing\n            this operation.\n      x-apigw-api-business-type: NORMAL\n      x-apigw-api-type: NORMAL\n      x-apigw-backend:\n        MockReturnHttpHeaders: []\n        MockReturnHttpStatusCode: 200\n        ServiceMockReturnMessage: ok\n        ServiceType: MOCK\n      x-apigw-cors: false\n      x-apigw-protocol: HTTP\n      x-apigw-service-timeout: 15\n",
    "ContentVersion": "openAPI"
}

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "ApiSet": [
                {
                    "ApiName": "test",
                    "Path": "/",
                    "Method": "GET",
                    "Status": "success",
                    "ErrMsg": "",
                    "ApiId": "api-xxxxxxx",
                    "CreatedTime": "2020-09-22T00:00:00+00:00"
                }
            ]
        },
        "RequestId": "61cb6d76-xxxx-xxxx-xxx-xxxxxxxxxx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation.ApiError api类错误。
InternalError 内部错误。
InternalError.OssException oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidServiceConfig 不合法的服务配置。
InvalidParameterValue.UnsupportedParameter 参数取值错误。
LimitExceeded.ApiCountLimitExceeded API数量超过限制。
MissingParameter.BackendSpecificParam 缺少后端服务参数。
ResourceNotFound 资源不存在。
UnauthorizedOperation.AccessResource 您没有权限访问资源。
UnsupportedOperation.InvalidAction 接口错误。
UnsupportedOperation.UnpackError Unpack函数错误