SpringBoot集成Swagger

最新推荐文章于 2025-05-30 11:24:46 发布

原创最新推荐文章于 2025-05-30 11:24:46 发布 · 236 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#SpringBoot #SpringFox #Swagger

SpringBoot 专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍如何在SpringMVC项目中集成Swagger，包括Maven配置、Application配置等步骤，并提供了一个具体的示例代码，最后给出了访问Swagger界面的URL。

简介

详见 SpringMVC集成Swagger

配置

Maven 配置

 <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <springfox.version>2.2.2</springfox.version>
    </properties>

 <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--Swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${springfox.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${springfox.version}</version>
        </dependency>
  </dependencies>

Application配置

@MapperScan("com.anotherme17.anothernote.mapper")
@SpringBootApplication
@EnableSwagger2
public class AnothernoteApplication {

    /*Swagger*/
    @Bean
    public Docket swaggerSpringMvcPlugin() {
        ApiInfo apiInfo = new ApiInfo("A...", "=  =", "1.0.0",
                "", "...", null, null);
        Docket docket = new Docket(DocumentationType.SWAGGER_2).select().paths(regex("/v1/*/.*")).build()
                .apiInfo(apiInfo).useDefaultResponseMessages(false);
        return docket;
    }

    public static void main(String[] args) {
        SpringApplication.run(AnothernoteApplication.class, args);
    }
}