SpringBoot集成Swagger操作

最新推荐文章于 2022-06-01 00:36:54 发布

闹啥了

最新推荐文章于 2022-06-01 00:36:54 发布

阅读量186

点赞数

分类专栏： SpringBoot

本文链接：https://blog.csdn.net/wpk19921018/article/details/106177447

版权

SpringBoot 专栏收录该内容

14 篇文章 1 订阅

订阅专栏

1. pom文件中引用Swagger依赖

<dependency>
	<groupId>io.swagger</groupId>
	<artifactId>swagger-annotations</artifactId>
	<version>1.5.14</version>
</dependency>

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.6.1</version>
</dependency>

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

2. 增加Swagger组件的扫描

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot 使用 Swagger2 构建RESTful API")
                //创建人
                .contact("XXX")
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

3. 启动项目进行测试