上云无忧 > 文档中心 > 腾讯云 API 网关 - 注意事项
腾讯云 API 网关 - 注意事项

文档简介:
您可以使用 API 网关将业务设计为 API 开放出来,在设计 API 时,为了方便您后续的使用,建议遵循以下规则设计 API:
*此产品及展示信息均由腾讯云官方提供。免费试用 咨询热线:400-826-7010,为您提供专业的售前咨询,让您快速了解云产品,助您轻松上云! 微信咨询
  免费试用、价格特惠
您可以使用 API 网关将业务设计为 API 开放出来,在设计 API 时,为了方便您后续的使用,建议遵循以下规则设计 API:
URI 的末尾不要添加斜杠/,资源的 URL 的末尾多一个斜杠会产生歧义,容易被误认为是目录,导致在调用过程中产生误解。
使用中划线-提高 URI 的可读性,用中划线-来连接单词这样可以使得 URI 便于理解。
禁止在 URL 中使用下划线_,因为下划线_有可能被文本查看器中的下划线特效遮掩,可读性较低。
避免使用大写字母,使用大写字母既不美观又容易出错。
不要在 URI 中包含扩展名,而应鼓励 REST API 客户端使用 HTTP 提供的格式选择机制 Accept request header。
相似文档
  • API 网关,针对共享实例下创建的服务,如需查看内网网关和外网 IP 可参考以下信息。 其中内网网段可用于内网互通、其中外网 VIP 可用于区分外网出流量最终用于账单计费,具体可参见 后端对接 VPC 内的 CLB 资源,或 共享实例计费 等。
  • 插件简介: 插件是 API 网关提供的高级功能配置,您可以通过插件创建 IP 访问控制、条件路由、断路器、防重放等能力项,再将插件绑定到 API 上生效。
  • 操作场景: IP 访问控制是 API 网关提供的安全防护能力,主要用于限制 API 的调用来源 IP,您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的 API 请求。
  • 操作场景: 基础流量控制插件是 API 网关提供的强大流控限制,支持API、应用、ClientIP 三个维度的限流和秒、分钟、小时、天的限流。您可创建基础流控插件并绑定到 API 生效,以保护您的后端服务。
  • 操作场景: 参数流控可以针对用户的请求参数以及用户在插件中设置的条件执行进行流控,参数流控配置支持如下特性: 支持秒、分钟、小时、天的流控维度。 可以根据客户端请求参数、API 网关内置的系统参数设置条件,来执行不同的流控维度。 可以使用单个参数、或多个参数的组合来设置流控。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部