上云无忧 > 文档中心 > 腾讯云 API 网关 - 导入 API
腾讯云 API 网关 - 导入 API

文档简介:
操作场景: 该任务指导您在 API 网关控制台通过导入 OpenAPI 来创建 API。
*此产品及展示信息均由腾讯云官方提供。免费试用 咨询热线:400-826-7010,为您提供专业的售前咨询,让您快速了解云产品,助您轻松上云! 微信咨询
  免费试用、价格特惠

操作场景

该任务指导您在 API 网关控制台通过导入 OpenAPI 来创建 API。

前提条件

已完成 服务创建
准备 OpenAPI 3.0.0 标准的 API 描述文件,文本格式为 YAML 或 JSON。

操作步骤

1. 登录 API 网关控制台,在左侧导航栏单击服务
2. 在服务列表中,单击目标服务的服务名,查看该服务。
3. 在服务信息中,单击管理 API 标签页,查看该服务下的 API 列表。
4. 单击 API 列表上方的导入 API,进入导入 API 页面。
5. 选择文本格式(YAML 或 JSON),并单击上传文件,选择要上传的 API 描述文件;或者直接在代码编辑器中输入描述 API 的内容。
6. 单击保存,API 网关将根据您输入的内容创建 API,并在创建完成后返回本次创建成功的 API 列表。

注意事项

导入 API 支持 OpenAPI 3.0.0 标准的 API 定义,支持 YAML 和 JSON 格式的描述文件。
单次不能同时导入超过10个API。
上传 API 描述文件时,文件后缀名必须为 .yaml 或 .json;单次上传的 API 描述文件不能超过 100KB;上传的描述文件会覆盖代码编辑器里的内容。
创建成功的 API 将不会自动发布,需要您手动发布后方可生效。
从标准 OpenAPI3.0 描述文件导入 API,需要手动添加 servers 字段,用来定义 API 访问的后端地址,例如:
		
servers:
- url: 'http://localhost:8080'
description: Generated server url
说明
OpenAPI 规范和 API 网关的映射关系请参见 定义 API
导入 API 的完整示例请参见 导入 API 示例
相似文档
  • 操作场景: 通过 API 调试页面,您可以在配置完 API 后立即验证 API 的正确性,发起模拟 API 调用并查看具体请求响应。如果 API 未按照您期望的方式工作,可以根据响应,重新修改配置以符合您的设计期望。
  • 操作场景: 在 HTTP 场景中,对响应数据进行压缩处理可有效降低数据传输量,达到减少响应时间、节省服务端网络带宽、提升客户端性能等目的。 该任务将指导您在 API 网关中配置响应压缩。
  • 操作场景: 使用 API 网关后端对接云函数 SCF 时,由于触发器限制,不支持直接上传二进制文件,必须经过 Base64 编码后上传。API 网关支持将客户端请求体 Base64 编码后传递给云函数 SCF,为 API 开启此功能后,您无需改造客户端代码即可将二进制文件上传至云函数 SCF。
  • 操作场景: 该任务指导您对密钥对认证的 API 发起调用。
  • 操作场景: 该任务指导您对免鉴权的 API 发起调用。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部