云市场云市场 API 网关操作说明-商品接入-文档中心-腾讯云

背景
由于腾讯云产品业务调整，API 网关产品将做如下调整：2024年07月01日00:00，产品停止售卖，范围是新、老用户无法再购买或创建资源，包含实例、服务、资源包。新用户指从未创建过 API 网关资源的用户。老用户已在使用中的服务暂不受影响。API 停售公告详情查看：【重要】API 网关产品停止售卖公告。
2024年07月01日之前通过 API 网关已经创建的 API 服务可以继续选择“API网关”发布云市场 API 商品；2024年07月01日后新增 API 服务请使用云市场 API 网关创建 API 服务，并且发布商品时需要选择"云市场API网关”中的 API 服务。
基本介绍
腾讯云产品业务调整后，发布 API 商品时，API 的创建动作由从 API 网关侧转移到云市场侧，本文主要引导您完成云市场 API 网关服务的创建和调试。
﻿
﻿
﻿
操作流程
﻿
﻿
﻿
1. 登录 API网关服务，选择“新建服务”。
﻿
﻿
﻿
2. 创建 API 网关服务，在创建过程中，需要填写服务商后端服务地址、访问协议（如 HTTP 或 HTTPS）、端口等关键信息。这些信息将用于 API 网关与后端服务之间的通信。API 网关服务创建成功后，在未绑定商品前，可对该服务进行编辑、删除和新建路由的操作。
﻿
﻿
﻿
3. 创建 API 网关路由，单击对应网关操作栏的“新建路由”。在此网关服务基础上创建路由，当前一个 API 网关服务只能创建一个路由。在创建路由时，需要指定路由规则、请求方法（如 GET、POST 等）以及后端服务对应的具体路径。当外部请求到达 API 网关时，它会根据路由规则转发到相应的后端服务进行处理。创建后可在“API网关服务>路由管理”处单击ID名称查看路由详情。
﻿
﻿
﻿
4. 绑定 API 商品，在创建 API 商品的过程中，需要选择绑定之前创建的 API 网关服务，让 API 商品继承 API 网关服务的相关配置，包括路由规则、后端服务地址等在完成 API 商品的创建及发布后供外部用户调用。
﻿
﻿
﻿
配置参数
创建 API 网关服务
﻿
﻿
﻿
字段配置
说明
服务名称
在单个地域内，服务名称必须是唯一的，且长度不得超过50个字符。
所属地域
不同地域的对外接口地址会有所不同。例如，如果选择了广州地域，网关最终部署在广州，对应的域名将为：ap-guangzhou.cloudmarket-apigw.com，可以为用户访问提供更好的服务。
服务地址
后端服务域名或者IP地址。
服务端口
一般 http 默认端口为80，https 默认端口为443，也可以选择自定义的端口。
服务协议
选择使用 http 或 https 协议。请注意，当您选择 https 协议时，服务端口必须选择 https 配置的端口。
服务路径
必须以“/”开头。
示例
假设服务商后端接口路径是：https://example.market.tencent.com/testadd，则各项值如下： 
服务地址：example.market.tencent.com
服务端口：443                                                            
服务路径：/testadd
创建 API 网关路由
﻿
﻿
﻿
字段配置
说明
路由名称
在单地域内，路由名称必须是唯一的，不能与其他路由名称重复。路由名称长度需在50个字符以内。
请求方法
指对外进行 API 调用时所使用的 HTTP 方法，如 GET、POST、PUT 等。
请求路径
用户需要自定义一个对外暴露的路径，该路径将追加到对外请求地址的末尾。当请求转发到服务商后端服务时，此路径不会包含在内。例如，若请求路径设置为/index，对外请求域名为 example.market.tencent.com，则完整的对外请求路径将是 example.market.tencent.com/index。
参数配置（ 参数配置用于生成接口文档供用户使用）
1. Query：查询参数将会拼接到 URL 路径的末尾，以问号（?）分隔。例如，若 URL 路径为/search，查询参数为keyword=test，则完整的请求 URL 将是/search?keyword=test；
2. Body：请求体参数适用于需要发送大量数据的场景，如 JSON 格式数据。该部分数据会填充到 http 请求的 body 消息体中；
3. Header：头部参数将会设置到 HTTP 请求头中，用于传递额外信息或进行身份验证等操作。常见的头部参数包括 Content-Type、Authorization 等。
路由详情中可查看访问地址。访问地址生成规则：http|https://{region}.cloudmarket-apigw.com/{service-id}/路由配置的请求路径。
﻿
﻿
﻿
API 网关调试
调试接口用来测试服务商服务是否成功接入到云市场 API 网关中，需进入到各路由详情页面进行调试，不要在调试页面更改地址栏中后缀地址（实际可更改），否则会调试失败。
﻿
﻿
﻿
﻿

字段配置	说明
服务名称	在单个地域内，服务名称必须是唯一的，且长度不得超过50个字符。
所属地域	不同地域的对外接口地址会有所不同。例如，如果选择了广州地域，网关最终部署在广州，对应的域名将为：ap-guangzhou.cloudmarket-apigw.com，可以为用户访问提供更好的服务。
服务地址	后端服务域名或者IP地址。
服务端口	一般 http 默认端口为80，https 默认端口为443，也可以选择自定义的端口。
服务协议	选择使用 http 或 https 协议。请注意，当您选择 https 协议时，服务端口必须选择 https 配置的端口。
服务路径	必须以“/”开头。

字段配置	说明
路由名称	在单地域内，路由名称必须是唯一的，不能与其他路由名称重复。路由名称长度需在50个字符以内。
请求方法	指对外进行 API 调用时所使用的 HTTP 方法，如 GET、POST、PUT 等。
请求路径	用户需要自定义一个对外暴露的路径，该路径将追加到对外请求地址的末尾。当请求转发到服务商后端服务时，此路径不会包含在内。例如，若请求路径设置为/index，对外请求域名为 example.market.tencent.com，则完整的对外请求路径将是 example.market.tencent.com/index。
参数配置（参数配置用于生成接口文档供用户使用）	1. Query：查询参数将会拼接到 URL 路径的末尾，以问号（?）分隔。例如，若 URL 路径为/search，查询参数为keyword=test，则完整的请求 URL 将是/search?keyword=test； 2. Body：请求体参数适用于需要发送大量数据的场景，如 JSON 格式数据。该部分数据会填充到 http 请求的 body 消息体中； 3. Header：头部参数将会设置到 HTTP 请求头中，用于传递额外信息或进行身份验证等操作。常见的头部参数包括 Content-Type、Authorization 等。

云市场 API 网关操作说明

本页目录：

背景

基本介绍

操作流程

配置参数

创建 API 网关服务

示例

创建 API 网关路由

API 网关调试