API 接口开发返回结果规范化解决方案
一、概述
Api Result，是 RESTful风格的API接口响应参数规范化的一套解决方案 。它是在实际应用环境下产生了，并不断更新和完善。 结合Spring Boot进行开发，让接口响应结果变得更加规范。
二、示例
{
"code":"111111",
"message":"Query Success",
"success":true,
"trace_id":"edf36a73796356d5bc9b6d81f4eb83d6",
"body":{
"categoryData":[
{
"id":"1265200246055809026",
"categoryName":"公告"
},
{
"id":"1257301514647777282",
"categoryName":"Java"
},
{
"id":"1257694082590060546",
"categoryName":"开发"
},
{
"id":"1257255039406452737",
"categoryName":"前端"
},
{
"id":"1257687302015299586",
"categoryName":"计划"
},
{
"id":"1258792800529727490",
"categoryName":"网站更新日志"
},
{
"id":"1257256132635013121",
"categoryName":"日志"
}
]
}
}
三、实体类属性介绍
CommonResponse
| 序号 | 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|---|
| 1 | code | String | 返回码 | |
| 2 | message | String | 返回码描述信息 | |
| 3 | success | Boolean | false | 响应结果状态，true：表示成功；false：表示失败 |
| 4 | traceId | String | 追溯码，json格式返回时，为 trace_id |
|
| 5 | header | Map<String, String> | 响应头 | |
| 6 | body | 泛型 <T> |
响应体 |
CommonPage
| 序号 | 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|---|
| 1 | currentPage | Long | 当前页 | |
| 2 | pageSize | Integer | 每页显示条数 | |
| 3 | totalElements | Long | 总条数 | |
| 4 | totalPages | Long | 总页数 | |
| 5 | content | 泛型 <T> |
数据 |
四、返回方法介绍
返回成功
-
CommonResponse.ok()
-
CommonResponse.ok(data)
返回失败
-
CommonResponse.error()
-
CommonResponse.error(msg)
-
CommonResponse.error(code, msg)
-
CommonResponse.error(iError)
五、IError介绍
IError是返回码和描述信息的接口。
你可以在返回时，使用。
为了方便，提供了常见的错误，将其命名为 Default。
你可以直接使用 IError.Default。
值得注意的是：成功的返回码是6个1，字符型，111111 。
六、中央仓库
-
什么是Restfull API Restfull API 从字面就可以知道，他是rest式的接口，所以就要先了解什么是rest rest 不是一个技术，也不是一个协议 rest 指的是一组架构约束条件和原则，提供了一个新的架构设计思路，满足这些约束条件和原则的应用程序或设计就是 RESTful 在REST规则中，有两个基础概念：对象、行为 对象就是我们要操作的对象，例如添加用户的操作，那么对象就是
-
目录 搜狗（目前好用，免费） 百度（现在收费了，送一定额度） 腾讯（收费的） 搜狗（目前好用，免费） def textToAudio_Sougou(message, filePath): # https://ai.so gou.com/doc/?url=/docs/content/tts/references/rest/ ''' cu
-
更改历史 2018-02-01 胡小根 初始化文档 1 历史、现状和发展 1.1 历史 1.2 现状 1.3 发展 难点：预测发展方向。 1.4 概念 GraphQL和GraphiQL GraphQL是技术 GraphiQL是浏览器IDE，以使用接口 2 安装和使用 2.1 安装 2.2 使用 2.2.1 试一试 http://graphql.org/swapi-graph
-
有一个短视频接口，我想知道如何能通过axios请求或者后端请求，直接获得视频地址 http://v.nrzj.vip/video.php?_t=0.9640358809997094 （1）放在浏览器可以直接下载视频，并每次下载不同的视频 （2）放在video的src中可以直接播放，并且每次创建video组件都会播放新的视频 （3）因为有时候接口会失败，失败时想做处理，所以src需要动态的，最好可以
-
本文向大家介绍动态webservice调用接口并读取解析返回结果，包括了动态webservice调用接口并读取解析返回结果的使用技巧和注意事项，需要的朋友参考一下 这里给大家带来的是动态webservice调用接口并读取解析返回结果的具体示例，非常的简单，注释也很详细，小伙伴们可以参考下。 以上所述就是本文的全部内容了，希望大家能够喜欢。
-
我在Google Directions API中搜索了文档，也在网上搜索了一下，没有找到我的难题的答案。我的机构开发了一个API，可以使用transit查找出发地和目的地之间最新的可能出发点，有几个返回“无结果”错误。然而，当我手动搜索谷歌地图时，我能够返回结果。 我的Google Directions API程序发出以下查询： https://maps.googleapis.com/maps/a
-
本章主要介绍OSS的开放接口。开发者在发送请求给OSS时，既可以使用带签名认证的请求，也可以使用匿名访问。当签名验证错误或者是访问没有权限的资源时，OSS返回的错误码请参考下一章，本章就不在举例了。 5.1 公共HTTP头定义 5.1.1 公共请求头（Common Request Headers） OSS的RESTful接口中使用了一些公共请求头。这些请求头可以被所有的OSS请求所使用，其详细定义
-
问题内容： 这怎么可能，我必须遵循标准 列表的大小现在为20。如果我将最大结果添加到条件中， ..现在列表的大小是18！ 我不明白定义最大结果后结果集的大小如何减小，因为行数小于定义的最大数。这肯定看起来像是个错误，还是再次出现了我不知道的一些奇怪的hibernate状态？ 如果您正在寻找该问题的答案，请确保阅读已接受的答案及其评论。 问题答案： 通过在Hibernate中打开SQL调试并比较生成
-
问题内容： 我正在尝试创建一种方法，从中可以查询数据库并检索整个表。 目前，如果我使用这些数据只是正常工作 中 的方法。但是，我希望该方法返回结果。 我正在了解当前代码。 我该如何实现？ 问题答案： 您永远不要通过公共方法来回避。这很容易导致资源泄漏，因为您不得不保持语句和连接打开。关闭它们将隐式关闭结果集。但是，将它们保持打开状态将导致它们悬而未决，并且当它们打开过多时，将导致数据库用尽资源。
-
介绍 缓存是提升应用性能的常用手段，为框架中最通用的功能，每个框架也都推出专属的、功能多 样的缓存库。这些差别使得开发人员不得不学习多种系统，而很多可能是他们并不需要的功能。 此外，缓存库的开发者同样面临着一个窘境，是只支持有限数量的几个框架还是创建一堆庞 大的适配器类。 一个通用的缓存系统接口可以解决掉这些问题。库和框架的开发人员能够知道缓存系统会按照他们所 预期的方式工作，缓存系统的开发人员只