API 文档

快速入门

最近更新时间:2020-12-17 16:01:53

初次使用腾讯云 API 网关服务,建议您先了解 API 网关 产品概述使用限制购买指南

通过 API 网关控制台,您可以快速进行创建服务、创建/调试 API、发布与访问等操作,基本操作步骤如下:

步骤1:注册腾讯云账号

如果已在腾讯云注册,可忽略此步骤。

步骤2:完成实名认证

如果已完成,可忽略此步骤。
详细认证流程请参见 实名认证介绍

步骤3:登录 API 网关

步骤4:创建服务

  1. API 网关控制台 左侧导航栏中单击【服务】,进入服务列表页。
  2. 单击【新建】,输入服务信息。
    • 服务名称:必填,最长50个字符,支持a-zA-Z0-9_,此处我们输入“exampleservice”。
    • 前端类型:此服务支持的协议类型,此处我们选择“HTTP”。
    • 备注:此服务支持的访问方式,此处我们填写“测试”。
  3. 单击【提交】,即可创建服务。

步骤5:创建后端类型为 mock 的 API

  1. 在服务列表页单击服务名称,进入服务详情页。
  2. 在服务详情页单击【管理 API】,进入 API 列表页。
  3. 单击【通用 API】>【新建】,输入 API 前端配置信息。
    • API名称:API名称,此处我们输入“exampleapi”。
    • 前端类型:支持 HTTP、WEBSOCKET 两种前端类型,此处我们选择“HTTP”。
    • 路径:此 API 的访问路径,此处我们填写“/”。
    • 请求方法:此 API 的请求方法,此处我们选择GET。
    • 鉴权类型:目前支持免鉴权、OAuth 2.0、密钥对三种方式,此处我们选择“免鉴权”。
    • 支持CORS:此 API 是否支持跨域资源共享,此处我们选择“是”。
    • 备注:此 API 的备注信息,此处我们填写“测试”
    • 参数配置:此 API 的前端参数,此处我们不填写。
  4. 单击【下一步】,输入 API 后端配置信息。
    • 后端类型:此 API 后端服务所属类型,此处我们选择“mock”。
    • 返回数据:mock返回数据,此处我们输入“hello world, hello apigateway”。
  5. 单击【完成】,即可创建后端类型为 mock 的 API。

步骤6:调试 API

  1. 在 API 列表页找到步骤5中刚创建的 API ,在操作栏中单击【调试】,进入 API 调试页面。
  2. Content-Type 选择 application/x-www-form-urlencoded。
  3. 单击【发送请求】,即可查看本次调试的返回结果。

步骤7:发布服务

服务创建后默认处于未发布状态,只有发布服务后才能正常访问。

  1. 在服务列表页找到之前创建的服务,在操作栏中单击【发布】,输入服务发布信息。
    • 发布环境:此服务本次发布到的环境,此处选择“发布”环境。
    • 备注:此服务本次发布的备注信息,此处填写“测试发布”。
  2. 单击【提交】,即可成功发布服务。
  3. 服务发布后,您可以通过服务提供的子域名访问 API。

遇到问题?

非常抱歉您在使用时遇到问题,您可以通过以下步骤解决问题:

  1. 查看 常见问题 文档,找到解决方案。
  2. 如果没能找到满意的解答,您可以通过 提交工单 联系我们。

相关文档

了解更多腾讯云 API 网关控制台操作,例如查看日志、查看监控、设置流控策略等,请参见 操作指南 文档。

目录