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

MIT
Java
跨平台
2019-12-05
Erwin_Feng

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

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

一、功能

  • 支持通用接口返回结果解决方案
  • 支持 API 接口返回结果解决方案
  • 支持分页接口返回结果解决方案

二、使用

查看 源码 功能测试Wiki 文档

三、示例

/**
 * 查询方法示例
 * @return {@link ResultModel}
 */
@ApiOperation(value = "查询方法示例")
@GetMapping
public ResultModel<?> get() {
    List<Map<String, String>> list = new ArrayList<>();
    Map<String, String> map1 = new HashMap<>();

    map1.put("name", "张飞");
    map1.put("desc", "燕人张飞");
    list.add(map1);

    Map<String, String> map2 = new HashMap<>();
    map2.put("name", "赵云");
    map2.put("desc", "常山赵子龙");
    list.add(map2);

    Map<String, String> map3 = new HashMap<>();
    map3.put("name", "关羽");
    map3.put("desc", "温酒斩华雄");
    list.add(map3);

    return ResultUtils.success(list);
}

 

响应结果如下:

{
  "success": true,
  "message": "Success",
  "data": [
    {
      "name": "张飞",
      "desc": "燕人张飞"
    },
    {
      "name": "赵云",
      "desc": "常山赵子龙"
    },
    {
      "name": "关羽",
      "desc": "温酒斩华雄"
    }
  ]
}

 

更多示例:

 

Models

 

的码云指数为
超过 的项目
加载中

评论(3)

李大胖胖汉
李大胖胖汉
这东西还可以提供一个默认的spring代理,拦截结果如果异常就直接创建一个有异常信息的Resultmode。
c
coderYao
这个view很像swagger
这就是昵称丶
本来就是swagger

暂无资讯

暂无问答

rest api result

最近写接口返回写的异常的烦躁,总感觉应该应该需要一个简单的协议,既让前端看了秒懂,又能让后端轻松的把各种异常信息给到前端,所以我就想把返回的信息和数据外面包一层。返回给前端的信息...

2016/12/02 17:36
96
0
JavaLib | Result让你的API接口统一化(2)

引言 JavaLib很早就实现了Result模块,我也一直在用,但那是针对公用API接口的,如果后端开发人员也像那样写API接口给前端的话,非常麻烦,所以,很早就决定要重写了,我也是参考了很多人的,...

2018/09/02 23:22
148
0
No result defined for action and result input -...

这是struts2的一个拦截器报的错误,当你的form中的数据有问题,比如说 <input type="text" name="bianliang" value="${bianliang}"> 当 bianliang值为NULL时,又或者变量是int,long,double而值...

2011/09/29 09:40
4K
0
【原创】使用 mysql_use_result 还是使用 mysql_store_result?

本文整理了关于 MySQL C API 中 mysql_use_result() 和 mysql_store_result() 的用法。

2013/12/21 11:40
8.8K
1
[mybatis]It's likely that neither a Result Type nor a Result Map was specified

Caused by: org.apache.ibatis.executor.ExecutorException: A query was run and no Result Maps were found for the Mapped Statement 'com.asiainfo.path.mapper.RoadPriceMapper.selectM...

2019/07/11 09:32
95
0
Exception Name: No result defined for action

在开发中总遇到这个问题,No result defined for action: 原因:Action中的属性值为空的时候,Struts2的默认拦截器会报错,但是又找不到input的Result,不能够把错误返回,所以报这种错误。...

2016/05/30 00:27
120
0
Struts2 的@Result注解

@Result 注解的作用就是告诉程序我的 Action 返回什么。 例如: name: 返回标识,例如: location: 本地文件 type:返回类型 redirect:action处理完后重定向到一个视图资源(如:jsp页面),...

2019/12/10 11:53
29
0
Result Type(Struts.xml配置)

一个提交到服务器的处理通常可以分为两个阶段: 第一个阶段查询服务器状态(查询或者更新数据库) 第二个阶段选择一个合适的结果页面其返回给用户(这里要讲的Result的内容)。 Struts2提供了...

2012/11/05 17:32
90
0
Struts2中的result组件

常用的几种Result组件 1)JSP响应 dispatcher :采用请求转发方式调用JSP组件响应。 redirect:采用请求重定向方式调用JSP组件响应。(在重定向后,原request和action都被销毁掉,因此在JSP...

2013/01/29 00:00
1.3K
0
Result-type-Dispatcher

1 配置文件: <result name="success" type="dispatcher"> <param name="location">foo.jsp</param> </result> 如果没有写type类型,默认的是dispatcher(就在下面这一行设置的),请看str...

2012/03/18 21:07
387
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部