Java开发⽂档Swagger的使⽤详细教程springboot中添加swagger
版本2.7.0
版本2.8.0
使⽤UI界⾯不同，个⼈⽐较喜欢2.7.0
1.导⼊swagger依赖
<!--swagger依赖-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
2.编写SwaggerConfig配置类
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import t.annotation.Bean;
import t.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger.web.UiConfiguration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
*
spring framework版本查看
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket buildDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(buildApiInf()) // .apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(""))// 需要⽣成⽂档的包的位置                .paths(PathSelectors.any())
.build();
}
private ApiInfo buildApiInf() {
return new ApiInfoBuilder()
.title("电影接⼝详情")
.description("Zuul+Swagger2构建RESTful APIs")
.version("1.0")
.build();
}
}
3.使⽤注解
@Api：修饰整个类，描述Controller的作⽤
@ApiOperation：描述⼀个类的⼀个⽅法，或者说⼀个接⼝
@ApiParam：单个参数描述
@ApiModel：⽤对象来接收参数
@ApiProperty：⽤对象接收参数时，描述对象的⼀个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使⽤该注解忽略这个API
@ApiError ：发⽣错误返回的信息
@ApiImplicitParam：⼀个请求参数
@ApiImplicitParams：多个请求参数

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。