本文档将指导您如何新建 API 以用于 MCP Server 服务
操作步骤
1. 登录 大模型安全网关控制台,在左侧导航栏中,选择 API。
2. 在 API > API 列表页面,单击新建 API。

3. 在基础信息页面,选择 API 基本信息,单击下一步。

参数名称 | 参数说明 |
所属应用 | 当前 API 所属应用 |
API 名称 | 必填,最长32个字符,支持中文、大小写字母、数字、_、()、(),实例下唯一 |
后端服务类型 | 必填,当前 API 的后端服务类型 |
鉴权方式 | 签名:适用于需要通过 AKSK 鉴权保护的 API 认证:适用于需要登录态会话保护的站点类 API,需额外配置认证信息,请参考 API 认证配置 免鉴权:适用于开放类 API |
4. 在前后端配置页面,根据不同的后端服务类型,配置相关参数,单击下一步。
Restful:填写对应 Restful 前后端服务信息。

参数名称 | 参数说明 |
请求路径 | 此 API 的对外请求路径与匹配方式 |
后端服务方式 | 此 API 对应的后端服务的组织方式 |
后端服务类型 | 此 API 对应的后端服务的网络连接方式 |
后端服务 | 此 API 对应的后端服务的网络连接信息 |
负载方式 | 此 API 对应的多个后端服务间的请求分发策略 |
协议类型 | 此 API 对应的后端服务协议类型,支持 http 和 https |
协议版本 | 此 API 对应的后端服务协议版本,支持 1.0、1.1 和 2.0 |
请求 host 类型 | 此 API 请求中的 host 头部信息处理方式 |
后端路径 | 此 API 对应的后端服务访问路径 |
数据库:填写对应数据库前后端服务信息。

参数名称 | 参数说明 |
请求路径 | 此 API 的对外请求路径与匹配方式 |
数据源 | 此 API 要操作的数据源 |
配置方式 | 脚本方式:自行编写脚本代码完成数据源服务配置 向导方式:根据服务引导完成数据源配置 |
Mock:填写对应 Mock 测试的前后端服务信息。

参数名称 | 参数说明 |
请求路径 | 此 API 的对外请求路径与匹配方式 |
响应码 | 此 API 的请求处理结果 |
5. 在高级配置页面,配置相关参数。

参数名称 | 参数说明 |
流量控制 | 配置此 API 的限流算法、限流方案及超时控制 |
健康检查 | 配置此 API 对应的后端服务健康检查方案 |
格式转换 | 配置此 API 请求和响应的数据格式协议类型 |
IP 黑名单 | 配置此 API 的 IP 黑名单,和 IP 白名单互斥 |
IP 白名单 | 配置此 API 的 IP 白名单,和 IP 黑名单互斥 |
6. 单击保存,即可完成创建 API。

7. 通过 API 调试页面,您可以在配置完 API 后立即验证 API 的正确性,发起模拟 API 调用并查看具体请求响应。如果 API 未按照您期望的方式工作,可以根据响应,重新修改配置以符合您的设计期望。在调试页面,选择应用及发布的 API 后,单击调试,即可查看本次调试的返回结果。
