api-result 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
api-result 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
api-result 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」 !
api-result 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」「最积极运营项目」 !
api-result 获得 2020 年度 OSC 中国开源项目评选「最积极运营项目」 !
授权协议 MIT
开发语言 Java
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
提 交 者 冯文议
适用人群 未知
收录时间 2019-12-05

软件简介

API接口返回结果规范化解决方案

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 。

六、中央仓库

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (5)

加载中
这个烂东西,发布个啥
2020/06/26 23:03
回复
举报
冯文议软件作者
我也觉得不好用,不灵活,正在升级
2020/07/11 01:27
回复
举报
这东西还可以提供一个默认的spring代理,拦截结果如果异常就直接创建一个有异常信息的Resultmode。
2019/12/31 09:46
回复
举报
这个view很像swagger
2019/12/05 18:44
回复
举报
本来就是swagger
2019/12/13 15:57
回复
举报
更多评论
暂无内容
发表于软件架构专区
2016/12/02 17:36

rest api result

最近写接口返回写的异常的烦躁,总感觉应该应该需要一个简单的协议,既让前端看了秒懂,又能让后端轻松的把各种异常信息给到前端,所以我就想把返回的信息和数据外面包一层。返回给前端的信息无非就result,data,message。写一个对象把这些封装起来,这样就大功告成。 ```java public class ApiResult { private static final String SUCCESS = "SUCCESS"; private static final String ERROR = "ERROR"; private static fina...

0
1
发表于开发技能专区
2018/09/02 23:22

JavaLib | Result让你的API接口统一化(2)

## 引言 JavaLib很早就实现了Result模块,我也一直在用,但那是针对公用API接口的,如果后端开发人员也像那样写API接口给前端的话,非常麻烦,所以,很早就决定要重写了,我也是参考了很多人的,看Spring Builder模式,有点糊涂,设计算是失败了。 ## 概要 我们先来看一下,长什么样吧。 ```java public class App { public static void main(String[] args) { // 成功,无数据,自定义返回码和描述 Result result1 = ResultRes...

0
2
2020/12/22 12:43

AIMaker-Return training result to api server-chris

AIMaker-Return training result to api server-chris 发布:2020-12-22 12:43:23.734762 作者:chris ### 作者邮箱:chris5_lin@asus.com ### 首页: ### 文档:None ### 下载链接 Copy from pypi.org 查询时间:10.222ms 渲染时间:10.348ms 本文同步分享在 博客“zhenruyan”(other)。 如有侵权,请联系 support@oschina.cn 删除。 本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。...

0
0
发表了博客
2011/09/29 09:40

No result defined for action and result input -...

这是struts2的一个拦截器报的错误,当你的form中的数据有问题,比如说 <input type="text" name="bianliang" value="${bianliang}"> 当 bianliang值为NULL时,又或者变量是int,long,double而值是字符串类型时,就出这个错了,所以你可以在当前页面加入以下标签 < div style ="color:red" > < s:fielderror /> </ div > 它就会显示拦截器的错误,并在struts的XML中对应action里加如 <result name="input">/errir.jsp</result> <result...

0
0
2020/09/29 19:51

mysql_store_result 和 mysql_use_result

之前在开发工程中实际有碰到这样的业务,批量从MySQL中查询大量数据,每次通过限制起始+limit数量的来分批次查询, 后来有同事推荐使用MySQL JDBC中的fetchSize()方法,不做分页通过一次大查询然后客户端流式读取来批量查询数据, 这个内部原理是否就是文中所说的使用了mysql_use_result接口读一行处理一行实现的流式? 或者也是mysql_store_result方式客户端边缓存边处理?请老师指教 作者回复: 对,这种一般就是用mysql_use_r...

0
0
发表了博客
2015/12/22 08:58

Result相关

本文大部分copy api。仅作平时查找,质量不高。 内置Result实现类: chain com.opensymphony.xwork2.ActionChainResult dispatcher默认 org.apache.struts2.dispatcher.ServletDispatcherResult freemarker org.apache.struts2.views.freemarker.FreemarkerResult httpheader org.apache.struts2.dispatcher.HttpHeaderResult redirect org.apache.struts2.dispatcher.ServletRedirectResult redirectAction org.apache.struts2...

0
1
发表了博客
2014/06/05 15:53

Result Types

第八章 Result Types 一个提交到服务器的处理通常可以分为两个阶段,第一个阶段查询服务器状态(查询或者更新数据库),第二个阶段选择一个合适的结果页面其返回给用户(这里要讲的Result的内容)。 Struts2提供了对不同种类返回结果的支持,常见的有JSP,FreeMarker,Velocity等。 Struts2支持的不同类型的返回结果为: 名字 说明 Chain Result 用来处理Action链 Dispatcher Result 用来转向页面,通常处理JSP FreeMarker Resu...

0
0
发表了博客
2012/11/09 15:22

Result类型

Result类型 Webwork提供了一些com.opensymphony.xwork.Result接口的实现来使你的action可以容易的用户交互.这些Result类型包括: Chain Result - 用于 Action Chaining Dispatcher Result - 用于 JSP 整合 FreeMarker Result - 用于 FreeMarker 整合 HttpHeader Result - 用于控制特殊的HTTP行为 JasperReports Result - 用于 JasperReports 整合 Redirect Result - 用于直接跳转到例外的URL Redirect Action Result - 用于直接跳...

0
0
发表了博客
2019/04/17 16:32

No result defined for action com.nynt.action.ManageAction and result input问题

No result defined for action com.nynt.action.ManageAction and result input 问题原因: 1)、 在action类中定义的一个return "input";在xml文件里没有东西接收。 举例说明: struts.xml 文件: <package name="file" namespace="/file" extends="struts-default"> <action name="inputFile" class="action.FileAction" method="inputFile"> <result name="success">/index.jsp</result> </action> </package> action类文件:...

0
0
发表了博客
2018/11/18 22:50

[JSON].result()

语法:[JSON].result() 返回:[True | False] 说明:用json字符串创建JSON实例时,如果该json字符串不是合法的json格式,会创建一个空的json实例。但是我们如果想知道toJson( jsonString )是否成功创建了实例,可以使用方法:[JSON].result() 去检测。 示例: <% okJsonString = "{div: 'hello word!'}" errorJsonString = "{hello word!}" Set jsonObj1 = toJson( okJsonString ) Set jsonObj2 = toJson( er...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
5 评论
22 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部