swagger2的简单使用

优点:

可以生成文档形式的API并提供给不同的团队使用

便于自己单测

无需过多冗余的word文档,这一点很重要,因为我在工作中就遇到这么一个情况,由于开发使用的文档和最新文档版本导致不一致,导致后期很烦人

=使用swagger流程=

1.引入pom依赖

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>

2.新建swagger2配置类

new class Swagger2

@Configuration //使用配置类注解
@EnableSwagger2 //启用这个配置类
public class Swagger2 {
/**
* @Description:swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
*/
@Bean //配置这个bean是为了让swagger扫描到controller
public Docket createRestApi() { // 为swagger添加header参数可供输入
// ParameterBuilder userTokenHeader = new ParameterBuilder();
// ParameterBuilder userIdHeader = new ParameterBuilder();
// List<Parameter> pars = new ArrayList<Parameter>();
// userTokenHeader.name("headerUserToken").description("userToken")
// .modelRef(new ModelRef("string")).parameterType("header")
// .required(false).build();
// userIdHeader.name("headerUserId").description("userId")
// .modelRef(new ModelRef("string")).parameterType("header")
// .required(false).build();
// pars.add(userTokenHeader.build());
// pars.add(userIdHeader.build()); return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("com.csylh.controller"))
.paths(PathSelectors.any()).build();
// .globalOperationParameters(pars);
} /**
* @Description: 构建 api文档的信息
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 设置页面标题
.title("swagger2构建接口数据文档,这里是文档的标题")
// 设置联系人
.contact(new Contact("留歌", "http://csylh.cn", "csylh36@163.com"))
// 描述
.description("留歌短视频,这里是描述信息")
// 定义版本号
.version("V-1.0").build();
} }

3.配置controller类,方法和实体类

3.1对于某一个Controller添加一个API====@Api

@Api:用在请求的类上,表示对类的说明

- tags="说明该类的作用,可以在UI界面上看到的注解"

- value="该参数没什么意义,在UI界面上也看到,所以不需要配置"

案例:

@Api(value = "用户注册登录接口",tags = {"登录注册注销的controller"})

public class UserController{}

3.2对于Controller不同的接口(方法)进行定义==@ApiOperation

@ApiOperation:用在请求的方法上,说明方法的用途、作用

- value="说明方法的用途、作用"

- notes="方法的备注说明"

案例:

@ApiOperation(value = "用户注册接口", notes="这是用户注册的接口,随便写都可以")

public ServerResponse register(@RequestBody Users user){

return iUserService.register(user);

}

接下来对方法参数情况进行分类

情况一:(String userId,String fanId)参数场景

方法参数的问题:上面的是@RequestBody这样的场景,有的时候就是一个个参数 (String userId,String fanId)

我们就可以使用@ApiImplicitParams来定义参数

@ApiImplicitParams:用在请求的方法上,表示一组参数说明

- @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

- name:参数名

- value:参数的汉字说明、解释

- required:参数是否必须传

- paramType:参数放在哪个地方

header --> 请求参数的获取:@RequestHeader

query --> 请求参数的获取:@RequestParam

path(用于restful接口)--> 请求参数的获取:@PathVariable

body(不常用)

form(不常用)

- dataType:参数类型,默认String,其它值dataType="Integer"

- defaultValue:参数的默认值

案例:

@ApiOperation(value="用户头像上传", notes="用户头像上传接口")

@ApiImplicitParam(name="userId", value="用户id", required=true,

dataType="String", paramType="query")

public ServerResponse uploadIcon(String userId,@RequestParam("file") MultipartFile[] files) throws IOException {

return iUserService.uploadIcon(userId,files);

}

情况二:参数是使用@RequestBody这样的场景

上面这样基本配置之后其实也是可以进行运行的,但是我们更好的是可以对传入的users参数做一些限制,例如,传入的username参数字段不能为空等

操作: 跟进Users这个实体类进行配置

因为Users是一个实体,所以就要定义为@ApiModel

@ApiModel:用于响应类上,表示一个返回响应数据的信息

这种一般用在post创建的时候,使用@RequestBody这样的场景

请求参数无法使用@ApiImplicitParam注解进行描述的时候)

案例:

@ApiModel(value = "用户对象,这里是解释",description = "这是用户对象,这里是描述")

public class Users {}

实体类上字段的处理

=前端必须传入过来的字段情况=@ApiModelProperty

//用户名字段
@ApiModelProperty(value = "用户名",name = "username",example = "liuge36",required = true)
private String username;
//前端传过来的密码字段
@ApiModelProperty(value = "密码",name = "password",example = "123456",required = true)
private String password;

====前端不需要传入过来的字段情况,不需要显示 @ApiModelProperty(hidden = true)

@ApiModelProperty(hidden = true)

private String id;

这样就不会显示出来了

===到这里,基本的使用就到位了,后期有机会跟新更多swagger2的用法

补充:定义包扫描

@MapperScan(basePackages="com.csylh.mapper")

swagger2的简单使用的更多相关文章

  1. 十、Spring boot 简单优雅的整合 Swagger2

    前言 swagger2 是什么,我这里就不说了,就是一个简单的接口文档,方便前后端联调. 其实之前没有想要到要使用swagger 的.因为我之前用的是YAPI ,不过这个是一个单独的工具.并且是开源的 ...

  2. Spring Boot 2.x (十二):Swagger2的正确玩儿法

    Swagger2简介 简单的来说,Swagger2的诞生就是为了解决前后端开发人员进行交流的时候API文档难以维护的痛点,它可以和我们的Java程序完美的结合在一起,并且可以与我们的另一开发利器Spr ...

  3. Spring Boot 集成 Swagger2 与配置 OAuth2.0 授权

    Spring Boot 集成 Swagger2 很简单,由于接口采用了OAuth2.0 & JWT 协议做了安全验证,使用过程中也遇到了很多小的问题,多次尝试下述配置可以正常使用. Maven ...

  4. 整合swagger2生成Restful Api接口文档

    整合swagger2生成Restful Api接口文档 swagger Restful文档生成工具 2017-9-30 官方地址:https://swagger.io/docs/specificati ...

  5. 谈谈Java常用类库中的设计模式 - Part Ⅰ

    背景 最近一口气看完了Joshua Bloch大神的Effective Java(下文简称EJ).书中以tips的形式罗列了Java开发中的最佳实践,每个tip都将其意图和要点压缩在了标题里,这种做法 ...

  6. Spring的学习与实战

    目录 一.Spring起步 学习路线图 Spring的基础知识 什么是Spring Spring框架核心模块 SpringBoot 第一个Spring应用DEMO 编写自己的第一个SpringMVC例 ...

  7. 【分布式】-- 基于Nacos、OpenFeign搭建的微服务抽奖系统后台小案例

    1.项目介绍 最近入项目之前要求熟悉一下SpringCloud Nacos微服务基于Feign接口调用并整合Swagger2进行接口文档展示给前端,所以自己按照要求来编写并整合了一套基于SpringC ...

  8. swagger2简单使用

    1.引入jar <!--引入swagger--> <dependency> <groupId>io.springfox</groupId> <ar ...

  9. Swagger2简单使用教程

    Swagger2简单使用教程 1.简介 ​ Swagger是为了解决企业中接口(api)中定义统一标准规范的文档生成工具.很多采用前后端分离的模式,前端只负责调用接口,进行渲染,前端和后端的唯一联系, ...

随机推荐

  1. Docker安装Skywalking APM分布式追踪系统

    环境介绍 本文使用虚拟机unbutu18+docker.本unbutu18系统IP地址为:192.168.150.134 大家在使用时记得将此地址换成自己的实际地址. docker的安装可参考:htt ...

  2. HBase的安装和使用

    文章作者:foochane  原文链接:https://foochane.cn/article/2019062801.html 1 Hbase基本介绍 Hbase是一个分布式数据库,可以提供数据的实时 ...

  3. Dig命令使用大全(转自别人翻译),稍加整理

    Dig简介:   Dig是一个在类Unix命令行模式下查询DNS包括NS记录,A记录,MX记录等相关信息的工具.由于一直缺失Dig man page文档,本文就权当一个dig使用向导吧.   Dig的 ...

  4. three.js实现球体地球2018年全球GDP前十国家标记

    概况如下: 1.SphereGeometry实现自转的地球: 2.THREE.Math.degToRad,Math.sin,Math.cos实现地图经纬度与三位坐标x,y,z之间的转换: 3.Imag ...

  5. SpringMVC整合Apache Shiro

    关于什么是Shiro,可以查看这篇文章http://www.cnblogs.com/Laymen/articles/6117751.html 一.添加maven依赖 <dependency> ...

  6. 洛谷P1217回文质数-Prime Palindrome回溯

    P1217 [USACO1.5]回文质数 Prime Palindromes 题意:给定一个区间,输出其中的回文质数: 学习了洛谷大佬的回溯写法,感觉自己写回溯的能力不是很强: #include &l ...

  7. HZNU Training 4 for Zhejiang Provincial Collegiate Programming Contest 2019

    今日这场比赛我们准备的题比较全面,二分+数论+最短路+计算几何+dp+思维+签到题等.有较难的防AK题,也有简单的签到题.为大家准备了一份题解和AC代码. A - Meeting with Alien ...

  8. hdu 3374 String Problem(最小表示法+最大表示法+kmp)

    题目链接:http://acm.hdu.edu.cn/showproblem.php?pid=3374 题意:给出一个字符串问这个字符串最小表示的最小位置在哪,还有有几个最小表示的串.最大表示的位置在 ...

  9. CSU 1803 2016 湖南省2016省赛

    1803: 2016 Submit Page   Summary   Time Limit: 5 Sec     Memory Limit: 128 Mb     Submitted: 1416    ...

  10. hdu 4722 Good Numbers 规律 数位dp

    #include<iostream> #include<cstring> #include<cstdio> #include<vector> #incl ...