|
请求数据格式+类型
- json格式：{items:[]}
- 请求创建students对象json(表达)：
- 请求(批量)创建student对象列表json(表达)
- 请求(批量)创建student信息excel文
响应header
- Content-Type
- aplication/json
- Content-Language(可选)
- 内容语言
- Last-Modified
- 数据最近一次修改的时间戳信息
响应值
- Success message：多种类型
- Error message：多种类型
- Exception：多种类型
统一异常处理
统一异常处理包括状态码以及状态码涵盖的异常信息，具体部分定义如下：
- 200/201+success message(含资源数量信息+uri信息)：创建成功，适用于数量不多(比如小于500)的创建操作，大于设定的值时进行异步处理，参加返回值202
- 202+success message with status uri：异步处理，返回进度查询资源uri(/api/vendor/v1/status/{id})
- 400+success+errors(含出错项index的错误列表)：批量创建时部分成功，返回成功信息和错误信息
- 401+exception{error_code+message}：缺乏认证信息
- 403+exception{error_code+message}：未授权访问，访问被拒绝
- 406+exception{ error_code+message}：不支持client要求的格式或语言时返回该信息(Not Acceptable)
- 415+exception{error_code+message}:请求中的文档格式不支持
- 422+exception{error_code+message}：不能处理的数据，比如json格式错误、文件内容项错误或会破坏业务规则
- 429+exception{ error_code+message}：太多请求，流控时使用
- 500+exception{error_code+message}：服务器内部错误
统一日志拦截
基于AOP模式拦截所有请求，在请求入站与出站的时候，做统一日志记录以及需要的其他非业务处理(例如鉴权)
统一的数据返回标准
我们参考Restful数据返回标准，封装我们自己的数据返回格式：code，message，body，error，统一的数据返回格式可以在接口层做统一的拦截处理。实现返回数据的标准化。
- code：返回状态码
- message：返回响应结果的语义解释
- body：响应的具体数据信息，包括metada信息，具体响应数据以及请求连接
- error：代表返回的错误信息
（编辑：西安站长网）
【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!
|
