这里只简单的说一下swagger的传值,返回值时注解的使用演示。相关注解及说明见其他文章

接收参数方式1

我们常规接收参数,可以使用一个类,类里面把属性作为接收的参数,使用注解对属性进行说明。但是这种传参方式,我调试的时候,支持前端的传参方式为:form-data

例子如下:

因为这种方式我们用的不多,所以这里就不展开来讲

一般我们前端都是传json数据过来后端,后端接收参数是直接用JSONObject或Map所以主要讲一下第二种

接收参数方式2

前端传参:json

后端接收:jsonObject或Map

对于这种JSONObject接收参数的,我们不能用第一种方式,此时应该用另外两个注解来实现

注意:dataType属性默认是String,如果要换成其他,比如int属性,不能直接写int或Interger,一定要加上全类名,不然会被解析成string类型。

代码如下:

 1      /**
2 * 测试接口
3 *
4 * @param jsonObject 前端传过来的参数
5 * @return 无
6 */
7 @PostMapping("/test")
8 @ApiOperation(value = "测试接口", httpMethod = "POST", notes = "测试,这是一个后端的测试接口")
9 @ApiImplicitParams({
10 @ApiImplicitParam(value = "这是具体的参数1说明", name = "parm1", required = true, dataType = "String",
11 paramType = "query"),
12 @ApiImplicitParam(value = "参数二是string类型", name = "parm2", required = true, dataType = "String",
13 paramType = "query"),
14 @ApiImplicitParam(value = "参数三是int类型", name = "parm3", required = true, dataType = "java.lang.Integer",
15 paramType = "query"),
16 @ApiImplicitParam(value = "参数四是布尔类型", name = "parm4", required = true, dataType = "java.lang.Boolean",
17 paramType = "query"),
18 @ApiImplicitParam(value = "参数五:0表示成功,1表示失败", name = "parm5", required = true, dataType = "String",
19 paramType = "query")
20 })
21 public JSONObject testParm(JSONObject jsonObject) {
22 ​
23 return null;
24 ​
25 }
26 ​
27 }

这样子看,可能显得代码略显臃肿,但是我们写代码的时候,把它折叠起来就好了,效果如下

接下来,看一下swagger中的具体效果图

响应参数

请求参数我们了解了,接下来我们看一下响应参数,首先所有的响应都要基于ResponseVo这个类。

 
 1 @Data
2 @ApiModel()
3 public class ResponseVo<T> implements Serializable {
4 @ApiModelProperty(value = "默认时间")
5 private String defaultTimeZone;
6 @ApiModelProperty(value = "成功为1,失败为0")
7 private Integer result;
8 @ApiModelProperty(value = "返回值信息")
9 private T data;
10 @ApiModelProperty(value = "返回给前端的语言,默认是:zh_CN")
11 private String lang;
12 @ApiModelProperty(value = "时间,默认是:Asia/Shanghai")
13 private String userTimeZone;
14 ​
15 ​
16 public ResponseVo(Integer result, T data) {
17 this(result, "Asia/Shanghai", "Asia/Shanghai", "zh_CN", data);
18 }
19 ​
20 ​
21 public ResponseVo(Integer result, String defaultTimeZone, String userTimeZone, String lang, T data) {
22 this.defaultTimeZone = defaultTimeZone;
23 this.result = result;
24 this.userTimeZone = userTimeZone;
25 this.lang = lang;
26 this.data = data;
27 }
28 ​
29 @Override
30 public String toString() {
31 return JSONObject.toJSONString(this);
32 }
33 }

 

swagger效果图

swagger调试效果图:

返回实列1

ok,接下来,我们进行一些复杂的操作,我们尝试模拟下面这里复杂的类型返回

可以看出 formFieldDataOrder是一个数组

tableData是一个对象

formFieldData是一个对象

java代码

首先创建两个类,然后在ResponseDataVo里面定义三个属性,,其中数组的用定义为List,对象定义为具体的类

注意:定义为返回值的类,一定要加上@ApiModel注解

返回值设置

swagger效果:

返回实列2

接下来,我们往里面添加数据

老样子,创建IslandId类和Name类,在FormFieldData类中设置这两个对象属性

设置对应的返回值

swagger效果图

swagger调试结果图

返回实列3

接下来,我们完善一下Island里面的属性

定义IslandId对象里面的属性

设置对应的值

swagger效果图

调试结果

到这里,swagger注解的使用算是入门了,注意,其中还是有很多细节要注意的,由于时间问题,没有一一列举出来。欢迎大家点评指正。

Swagger3注解使用的更多相关文章

  1. SpringBoot整合Swagger3生成接口文档

    前后端分离的项目,接口文档的存在十分重要.与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低.与swagger2相比新版的swagg ...

  2. SpringBoot第十一集:整合Swagger3.0与RESTful接口整合返回值(2020最新最易懂)

    SpringBoot第十一集:整合Swagger3.0与RESTful接口整合返回值(2020最新最易懂) 一,整合Swagger3.0 随着Spring Boot.Spring Cloud等微服务的 ...

  3. Spring Boot集成Springfox Swagger3和简单应用

    摘要:Springfox Swagger可以动态生成 API 接口供前后端进行交互和在线调试接口,Spring Boot 框架是目前非常流行的微服务框架,所以,在Spring Boot 项目中集成Sp ...

  4. SpringBoot: 后台接口文档 - 基于Swagger3

    目录 前言:什么是Swagger 起步:(只需简单的3步) 加载依赖 添加注解@EnableOpenApi 启动SpringBoot,访问Swagger后台界面 配置:基于Java的配置 注解:Swa ...

  5. gateway聚合swagger3统一管理api文档

    springboot微服务整合swagger3方法很简单,下文会演示.但是在分布式项目中如果每个微服务都需要单独的分开访问获取接口文档就不方便了,本文将详细讲解springcloud gateway网 ...

  6. 基于spring注解AOP的异常处理

    一.前言 项目刚刚开发的时候,并没有做好充足的准备.开发到一定程度的时候才会想到还有一些问题没有解决.就比如今天我要说的一个问题:异常的处理.写程序的时候一般都会通过try...catch...fin ...

  7. [Spring]IoC容器之进击的注解

    先啰嗦两句: 第一次在博客园使用markdown编辑,感觉渲染样式差强人意,还是github的样式比较顺眼. 概述 Spring2.5 引入了注解. 于是,一个问题产生了:使用注解方式注入 JavaB ...

  8. Android注解使用之通过annotationProcessor注解生成代码实现自己的ButterKnife框架

    前言: Annotation注解在Android的开发中的使用越来越普遍,例如EventBus.ButterKnife.Dagger2等,之前使用注解的时候需要利用反射机制势必影响到运行效率及性能,直 ...

  9. Android注解使用之注解编译android-apt如何切换到annotationProcessor

    前言: 自从EventBus 3.x发布之后其通过注解预编译的方式解决了之前通过反射机制所引起的性能效率问题,其中注解预编译所采用的的就是android-apt的方式,不过最近Apt工具的作者宣布了不 ...

随机推荐

  1. npm & app-node-env

    npm & app-node-env $ npm i -g app-node-env # OR $ yarn global add app-node-env demo $ ane env=ap ...

  2. Mac Benchmarks

    Mac Benchmarks https://browser.geekbench.com/mac-benchmarks https://www.geekbench.com/ https://www.f ...

  3. vux使用

    Vue中使用vux的配置,分为两种情况: 一.根据vux文档直接安装,无需手动配置 npm install vue-cli -g // 如果还没安装 vue init airyland/vux2 my ...

  4. TypeScript——02——TS基本数据类型介绍和使用

    一,TS的数据类型 ES6的数据类型: 6种基本数据类型 Boolean Number String Symbol undefined null 3种引用类型 Array Function Objec ...

  5. SpringBoot进阶教程(七十一)详解Prometheus+Grafana

    随着容器技术的迅速发展,Kubernetes已然成为大家追捧的容器集群管理系统.Prometheus作为生态圈Cloud Native Computing Foundation(简称:CNCF)中的重 ...

  6. eclipse从接口快速跳转到实现类

    1.只跳转到实现类上 按住Ctrl键,把鼠标的光标放在要跳转的接口上面,选择第二个 2.直接跳转大实现的方法上 按住Ctrl键,把鼠标的光标放在要跳转的方法上面,选择第二个 对比可以发现,操作都是一样 ...

  7. 逆向基础 C++ Primer Plus 第二章 开始学习C++

    C++ Primer Plus 第二章 开始学习C++ 知识点梳理 本章从一个简单的C++例子出发,主要介绍了创建C++程序的步骤,以及其所包含的预处理器编译指令.函数头.编译指令.函数体.注释等组成 ...

  8. java的基础知识

    编写一个hello,world public  class  Hello{    public static void main(String[] arge){        System.out.p ...

  9. hexo 报错 use_date_for_updated is deprecated...

    hexo 报错 use_date_for_updated is deprecated... WARN Deprecated config detected: "use_date_for_up ...

  10. MVCC多版本并发控制器

    在多个事务并发执行的时候,MVCC机制可以协调数据的可见性,事务的隔离级别就是建立在MVCC之上的: MVCC机制通过undo log链和ReadView机制来实现: undo log版本链: 在数据 ...