前端配置
最近更新时间: 2024-06-12 15:06:00
API 的前端配置，是指的提供给外界访问的相关配置，包括请求协议、HTTP 方法、URL 路径、入参的定义。
请求协议：API 网关支持 HTTP/HTTPS 协议，可选择 仅HTTP、仅HTTPS、HTTP和HTTPS 三种支持方式。
HTTP 方法：可选择 GET、POST、PUT、DELETE、PATCH、HEAD 方法。
URL 路径（Path）：您可以按需求写入合法 URL 路径。如需要在路径中配置动态参数，请使用
{}符号，并在其中填入参数名，例如/user/{userid}路径，申明了路径中的 userid 参数，此参数同时需要在入参中作为 Path 类型参数进行定义。Query 参数可以不用在 URL 路径中定义。入参：入参包含了来源于 Header，Query，Path，Body 的参数。其中 Path 参数对应于在 URL 路径中定义的动态参数；Body 参数仅在 HTTP 方法为 POST、PUT、PATCH 时存在，并可指明为 Form 格式或非 Form 格式。任一参数，均需要指定参数名，参数类型，参数数据类型、同时可以指明是否必填、默认值、示例数据、描述说明。利用这些配置，API 网关可以协助您完成入参的文档化和初步校验。
