springboot集成swagger

文章目录

swagger
swagger使用
- maven引入
- 添加配置类
- swagger注解说明
- 启动项目进行访问

swagger

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
Swagger UI提供了一个集成的测试工具，可以帮助开发人员测试API的功能、性能和可靠性。开发人员可以使用Swagger UI来测试API的不同端点和不同参数，以确保API的功能、性能和可靠性。

swagger使用

maven引入

springboot版本为2.2.1.RELEASE

<!--swagger2依赖-->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>

添加配置类

package com.rc.rc_exam.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;/**1. swagger配置类*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//是否开启 (true 开启  false隐藏。生产环境建议隐藏)//.enable(false).select()//扫描的路径包,设置basePackage会将包下的所有被@Api标记类的所有方法作为api，自行更改自己的包路径，到controller就行了.apis(RequestHandlerSelectors.basePackage("com.demo.controller"))//指定路径处理PathSelectors.any()代表所有的路径.paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder()//设置文档标题(API名称).title("SpringBoot中使用Swagger2接口规范")//文档描述.description("接口说明")//服务条款URL.termsOfServiceUrl("http://localhost:8098/")//版本号.version("1.0.0").build();}
}