描述
前端信息项
节点名
RequestConfig
子节点
名称 | 类型 | 描述 |
RequestProtocol | String | API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:”HTTP,HTTPS”,取值为:HTTP、HTTPS |
RequestHttpMethod | String | HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS |
RequestPath | String | API path,比如API的完全地址为http://api.a.com:8080/object/add?key1=value1&key2=value2,path是指/object/add这一部分 |
RequestMode | String | 请求的模式,取值为:MAPPING、PASSTHROUGH,分别表示入参映射、入参透传 |
BodyFormat | String | POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:FORM、STREAM,分别表示表单形式(k-v对应)、字节流形式。当RequestMode值为MAPPING时有效。 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
前端信息项配置指南
在配置API的前端信息时,主要关注RequestConfig
节点下的子节点参数,这些参数定义了API的基本交互方式和请求细节。以下是关键参数的详细说明:
RequestProtocol
HTTP
和 HTTPS
。HTTP,HTTPS
RequestHttpMethod
GET
, POST
, DELETE
, PUT
, HEADER
, TRACE
, PATCH
, CONNECT
, OPTIONS
等。POST
RequestPath
http://api.a.com:8080/object/add?key1=value1
中,/object/add
即为RequestPath。/api/billing/test/[type]
此外,还有其他可选配置项,如:
BodyFormat(当 RequestMode 为 MAPPING 时有效):
POST
或 PUT
请求,指定数据传递给服务器的方式。可选值为 FORM
(表单形式,k-v对应)和 STREAM
(字节流形式)。STREAM
RequestMode:
MAPPING
(入参映射,过滤未知参数)、PASSTHROUGH
(入参透传)、MAPPING_PASSTHROUGH
(入参映射同时透传未知参数)。MAPPING
请注意,根据实际需求选择合适的配置,确保API能够正确且高效地与客户端及后端服务交互。