您的当前位置:首页正文

SpringBoot 集成 Swagger-ui

2024-11-29 来源:个人技术集锦

1、pom.xml下引入依赖

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

2、在config下新建SwaggerConfig类

package com.jk193_ky.usermanage.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;

/**
 * Author: GuangZhanWen
 * Date: 2022/10/2 15:04
 * ProjectName: UserManage
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket restApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("标准接口")
                .apiInfo(apiInfo("Spring Boot中使用Swagger2构建RESTful APIs", "1.0"))
                .useDefaultResponseMessages(true)
                .forCodeGeneration(false)
                .select()
//               basePackage controller成的路径
                .apis(RequestHandlerSelectors.basePackage("com.jk193_ky.usermanage.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息(这些基本信息会展现在文档页面中)
     * 访问地址:http://ip:port/swagger-ui.html
     *
     * @return
     */
    private ApiInfo apiInfo(String title, String version) {
        return new ApiInfoBuilder()
                .title(title)
                .description("更多请关注: https:///xqnode")
                .termsOfServiceUrl("https:///xqnode")
                .contact(new Contact("xqnode", "https:///xqnode", "xiaqingweb@163.com"))
                .version(version)
                .build();
    }
}

3、如果报 Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

则在application.iml加入

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

显示全文