SpringBoot整合Swagger2实例方法 - 行业资讯 - 肥雀云

在进行软件开发的时候免不了要写接口文档,这些文档需要明确写出接口的类型,请求的URL,传参和返回值格式等信息,用于和前端交互或者提供给测试进行接口测试。但是手写文档一方面带给我们很大的工作量,另一方面如果接口有变更则需要频繁修改并且发给相关的人,无形中增加了工作量。小编为大家介绍一个生成文档的工具大摇大摆,上手简单,学习成本低,非常适合开发SpringBoot项目,现在就跟着小编一起学习吧。

首先需要在pom文件中加入swagger2的依赖,依赖的jar包如下图所示。

　　　　　　& lt; dependency> 　　& lt; groupId> io.springfox 　　& lt; artifactId> springfox-swagger2 　　& lt; version> 2.8.0 　　& lt;/dependency> 　　& lt; dependency> 　　& lt; groupId> io.springfox 　　& lt; artifactId> springfox-swagger-ui 　　& lt; version> 2.8.0 　　& lt;/dependency> 　　　　

SpringBoot整合Swagger2实例方法

编写大摇大摆配置类Swagger2Config,在类上增加@ configuration和@EnableSwagger2注解,表明这是一个配置类,同时开启大摇大摆。如下的信息可以根据具体情况修改。

　　　　　　@ bean 　　公共摘要api () { 　　返回新摘要(DocumentationType.SWAGGER_2) 　　.apiInfo (apiInfo ()) 　　.select ()//自行修改为自己的包路径　　.apis (RequestHandlerSelectors.basePackage (“com.spring.jpa.user”)) 　　.paths (PathSelectors.any ()) 　　.build (); 　　} 　　　　私人ApiInfo ApiInfo () { 　　返回新ApiInfoBuilder () 　　.title (“swagger-api文档”) 　　.description(“用户信息相关”)//服务条款网址　　.termsOfServiceUrl (“https://baidu.com”) 　　.version (“1.0”) 　　.contact(新联系人(“NWSL”、“http://baidu.com”,“111111 @qq.com”)) 　　.build (); 　　} 　　　　之前　　　　

SpringBoot整合Swagger2实例方法

接下来我们需要在控制器层添加注解,@Api (value=" https://www.yisu.com/test1 ",标签=安馐杂没Ы涌谀？椤?,,@Api这个注解是用在请求的类上,表示对类的说明,其中标签=八得鞲美嗟淖饔?可以在UI界面上看到的注解”,value=" https://www.yisu.com/zixun/该参数没什么意义,在UI界面上也看的到,所以不需要配置”。该注解的使用如下图所示。

SpringBoot整合Swagger2实例方法

接下来我们需要在方法上添加注解了,如下所示,@ApiOperation, @ApiImplicitParams, @ApiImplicitParam的作用如下图所示.@ApiResponses:用在请求的方法上,表示一组响@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息。

在方法中的使用如下图所示。

　　　　　　@ApiOperation(值=" https://www.yisu.com/zixun/添加用户信息”,指出=疤砑佑没畔ⅰ? 　　@ApiImplicitParams ({ 　　@ApiImplicitParam (name=懊帧?value=" https://www.yisu.com/zixun/用户姓名”,要求=true,数据类型=白址?paramType=安檠?, 　　@ApiImplicitParam (name="时代”,value=" https://www.yisu.com/zixun/用户年龄”,要求=true, paramType=安檠? 　　}) 　　　　

注意如果是整数类型,那数据类型=罢本涂梢允÷粤?写上了反而在生成的文档调用的时候出错。

SpringBoot整合Swagger2实例方法