上云无忧 > 文档中心 > 腾讯云 API 网关 - 创建后端对接 Mock 的 API
腾讯云 API 网关 - 创建后端对接 Mock 的 API

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

操作场景

该任务指导您通过 API 网关控制台创建后端对接 Mock 的 API。
注意
后端对接 Mock 仅能返回固定数据,建议您在测试过程中使用,不建议在真实业务场景中使用。

前提条件

已完成 服务创建

操作步骤

步骤1:新建通用 API

1. 登录 API 网关控制台 ,在左侧导航栏单击服务
2. 在服务列表中,单击目标服务的服务名,查看该服务。
3. 在服务信息中,单击管理 API 标签页。
4. 单击新建,进行后续配置。

步骤2:前端配置

API 的前端配置指提供给外界访问的相关配置,包括 API 名称、前端类型、请求协议、HTTP 方法、URL 路径和入参的定义。

前端基础信息配置

API 名称:您创建的 API 的名称,在当前服务内具有唯一性,支持最长60个字符。
API 类型:可选择通用 API、微服务 API。根据支持的后端类型判断,此处应选择通用API。
前端类型:可支持 HTTP&HTTPS、WS&WSS 两种前端类型。
路径:您可以按需求写入合法 URL 路径。如需要在路径中配置动态参数,请使用{}符号,并在其中填入参数名,例如/user/{userid}路径,申明了路径中的 userid 参数,此参数同时需要在入参中作为 Path 类型参数进行定义。Query 参数不是必须在 URL 路径中定义的。 路径支持正则表达式方式匹配,路径输入内容以/user为例:
=/user:代表精确匹配,当存在多个 API 接口都有/user时,优先匹配含有=/user的配置的 API 接口。
/user/{id}:代表路径上存在动态参数,当存在多个 API 接口都有/user时,优先级第三匹配含有动态参数的配置的 API 接口。
/user:表示完全匹配或前缀匹配的方式访问,访问时/user/usertest/user/test/a都可以访问到/user路径的 API 接口。
请求方法:可选择 GET、POST、PUT、DELETE、HEAD 、ANY 方法。
鉴权类型:支持 免认证应用认证OAuth 2.0EIAM认证密钥对认证 鉴权类型。
支持 CORS:用于配置跨域资源共享(CORS),开启后将默认在响应头中添加 Access-Control-Allow-Origin : *

前端参数配置

入参:入参包含了来源于 Header、Query、Path 的参数。其中 Path 参数对应于在 URL 路径中定义的动态参数。任一参数,均需要指定参数名,参数类型和参数数据类型;同时可以指明是否必填、默认值、示例数据和描述说明。利用这些配置,API 网关可以协助您完成入参的文档化和初步校验。

步骤3:后端配置对接 Mock

Mock 会对 API 请求返回固定配置的响应。Mock 常用于测试开发,可以在后端服务还未完成的情况下预先完成 API 配置和响应。对接 Mock 时,只需要配置您的返回数据,单击完成即可。

相似文档
  • 操作场景: 该任务指导您通过 API 网关控制台创建后端对接腾讯微服务平台 TSF 的 API。
  • 操作场景: 该任务指导您在 API 网关控制台通过导入 OpenAPI 来创建 API。
  • 操作场景: 通过 API 调试页面,您可以在配置完 API 后立即验证 API 的正确性,发起模拟 API 调用并查看具体请求响应。如果 API 未按照您期望的方式工作,可以根据响应,重新修改配置以符合您的设计期望。
  • 操作场景: 在 HTTP 场景中,对响应数据进行压缩处理可有效降低数据传输量,达到减少响应时间、节省服务端网络带宽、提升客户端性能等目的。 该任务将指导您在 API 网关中配置响应压缩。
  • 操作场景: 使用 API 网关后端对接云函数 SCF 时,由于触发器限制,不支持直接上传二进制文件,必须经过 Base64 编码后上传。API 网关支持将客户端请求体 Base64 编码后传递给云函数 SCF,为 API 开启此功能后,您无需改造客户端代码即可将二进制文件上传至云函数 SCF。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部