springboot集成swagger2.9.2详细步骤

最新推荐文章于 2024-10-07 22:12:25 发布

JAVA菜鸟594

最新推荐文章于 2024-10-07 22:12:25 发布

阅读量878

点赞数 1

分类专栏： springboot 文章标签： spring boot

本文链接：https://blog.csdn.net/cyzyt520520/article/details/108592980

版权

springboot 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

在pom.xml文件添加相关依赖

 <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>

创建配置类Swagger2Config.java

package com.oracle.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径,控制器类包
              .apis(RequestHandlerSelectors.basePackage("com.oracle.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot集成Swagger2构建RESTful API")
                //创建人
                .contact(new Contact("姓名", "个人网址",  "你的邮箱"))
                //版本号
                .version("1.0")
                //描述
                .description("演示系统API描述")
                .build();
    }
}