分类：Swagger2

2021
09-20

swagger2隐藏在API文档显示某些参数的操作

swagger2隐藏在API文档显示某些参数有时候，利用swagger2建立API文档时，有些参数是需要隐藏在API文档显示，在方法中，参数的名字前加上@ApiIgnore就可以了：@PostMapping("modi/certificate")@ApiResponses({@ApiResponse(code=0,message="请求成功"),@ApiResponse(code=10031,message="商家的营业执照已经存在，不能重复入驻")})@ApiOperation(value="修改商家证照资料",notes="修改商家证照资料",resp... 继续阅读 >

2020
10-10

springboot 配置使用swagger2操作

swagger是一个功能强大的在线API文档的框架，提供了优雅的API在线文档的查阅和测试功能。利用swagger2可以很方便的构建RESTful风格的API文档，在springboot中使用也非常方便，主要是在controller前配置添加注解就可以了，详细配置过程如下：1.maven依赖包使用目前最新版本为例，pom.xml添加的代码如下<!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui--><dependency><groupId>io.springf... 继续阅读 >

2020
10-10

SpringBoot2.0集成Swagger2访问404的解决操作

最近使用最新的SpringBoot2.0集成Swagger2的时候遇到一个问题，集成之后打开Swagger页面的时候出现404，后台提示找不到swagger-ui的页面。于是我看了下项目依赖swagger的结构：可以看到swagger-ui.html在META-INF/resources目录下，所以我们需要手动的将静态资源路径指向这里，在java中配置为：importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importorg.spr... 继续阅读 >

2020
10-10

Swagger2匹配多个controller代码实例

方法一：使用多个controller的共同拥有的父类，即精确到两个controller的上一级@BeanpublicDocketcreateRestApi(){returnnewDocket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.shubing")).paths(PathSelectors.any()).build();}方法二：指定所有controller的都实现的一个接口，比如@RestController@BeanpublicDocketcreate... 继续阅读 >

2020
10-09

Spring Boot Swagger2使用方法过程解析

1.添加Swagger2依赖<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.2.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.2.2</version></dependency>2配置类@Configuration@EnableSwagger2publicclassSwagger2{@BeanpublicDocketcreateRestApi(){returnnewDocket(... 继续阅读 >

2020
10-08

SpringBoot如何优雅地使用Swagger2

前言SpringBoot框架是目前非常流行的微服务框架，我们很多情况下使用它来提供RestAPI。而对于RestAPI来说很重要的一部分内容就是文档，Swagger为我们提供了一套通过代码和注解自动生成文档的方法，这一点对于保证API文档的及时性将有很大的帮助。本文将使用Swagger2规范的Springfox实现来了解如何在SpringBoot项目中使用Swagger，主要包含了如何使用Swagger自动生成文档、使用Swagger文档以及Swagger... 继续阅读 >

2020
09-29

springboot swagger2注解使用的教程

swagger2注解整体说明  最近在使用Swagger的时候忘记了注解的用法，特此记录一下。@Api：用在请求的类上，表示对类的说明tags="说明该类的作用，可以在UI界面上看到的注解"value="该参数没什么意义，在UI界面上也看到，所以不需要配置"@ApiOperation：用在请求的方法上，说明方法的用途、作用value="说明方法的用途、作用"notes="方法的备注说明"@ApiImplicitParams：用在请求的方法上，表示一组参数说... 继续阅读 >

2020
09-24

SpringBoot整合Swagger2代码实例

首先遵循SpringBoot的三板斧第一步添加依赖<!--SwaggerUI接口文档http://{ip}:{prot}/swagger-ui.html--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>{version}</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swaggerui</artifactId><version>{version}</version></dependency>第二步添加注解@EnableSwa... 继续阅读 >