没有合适的资源?快使用搜索试试~ 我知道了~
NEIAPI#nei-toolkit#NEI平台HTTP接口规范配置说明1
需积分: 0 0 下载量 33 浏览量
2022-07-25
14:31:41
上传
评论
收藏 5KB MD 举报
温馨提示
试读
响应结果规范数据模型该规范使用json来定义,其定义的形式为Array<Rule>,其中Rule的数据模型如下各字段的解释如下如一个合理的配置如下:接口出入参规
资源推荐
资源详情
资源评论
在项目组的设置页面,你可以制定项目组的HTTP接口规范,使得团队在定义HTTP接口上达成一致。
其中,`请求路径规范` `参数规范` `请求方式规范` `标签规范` ,规范的判断使用正则表达式,不需要在头部添加`/`,不支持正则表达式的标志(flag),建议添加`^`与`$`匹配开头与结尾来防止一些错误情形的出现。
* 注意:为了兼容老接口,约定在设置规范之前创建的接口时,对于不规范的输入,只会提示,不会限制更新。
### 请求路径规范
该规范匹配HTTP接口的路径(接口创建时填写的路径,接口更新路径时)。
比如,请求路径强制小写,可以使用路径参数的正则表达式为`^\/[a-z0-9/:{}-]+(\?([a-zA-Z0-9=&:{}]+)*)?$`
### 参数规范
该规范匹配HTTP接口中的所有参数的名称。
比如,参数可以使用驼峰的正则表达式为`^[a-z][a-zA-Z0-9]*$`
### 参数的描述规范
该规范匹配HTTP接口中的所有参数的描述信息。
比如,希望参数的描述必须填写,则可以使用非空的正则表达式为`\S+`
### 请求方式规范
该规范匹配HTTP接口中的请求方式。
比如,只能使用`GET`方法或`POST`方法请求的正则表达式为`^(GET|POST)$`
### 标签规范
该规范匹配HTTP接口中的标签。
### 响应结果规范
该规范匹配HTTP接口的响应结果的参数定义。
#### 响应结果规范数据模型
该规范使用json来定义,其定义的形式为`Array`,其中`Rule`的数据模型�
点击阅读更多
资源评论
八位数花园
- 粉丝: 45
- 资源: 281
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功