SpringBoot项目集成Swagger

最新推荐文章于 2025-01-14 15:09:48 发布

原创最新推荐文章于 2025-01-14 15:09:48 发布 · 3.7k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#swagger

java 专栏收录该内容

23 篇文章

订阅专栏

本文介绍了在Spring项目中集成Swagger2的步骤。首先在pom文件加入相关依赖，接着在Application入口类加上注解@EnableSwagger2，然后创建swagger配置类，最后在controller类中使用swagger标签，屏蔽部分spring - boot自带接口并设置主界面信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.pom文件加入依赖：

<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.Application入口类加上注解@EnableSwagger2

2.创建swagger配置类：

package com.**.knot.conf;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.google.common.base.Predicates;

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;

@Configuration
@EnableSwagger2
public class Swagger2Config {

/**
* 屏蔽部分的spring-boot自带的接口
*
* @return
*/
@Bean

public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.any())
.paths(Predicates.not(PathSelectors.regex("/error.*"))).paths(Predicates.not(PathSelectors.regex("/info.*")))
.paths(Predicates.not(PathSelectors.regex("/autoconfig.*")))
.paths(Predicates.not(PathSelectors.regex("/health.*")))
.paths(Predicates.not(PathSelectors.regex("/metrics.*")))
.paths(Predicates.not(PathSelectors.regex("/mappings.*")))
.paths(Predicates.not(PathSelectors.regex("/trace.*")))
.paths(Predicates.not(PathSelectors.regex("/configprops.*")))
.paths(Predicates.not(PathSelectors.regex("/beans.*"))).paths(Predicates.not(PathSelectors.regex("/env.*")))
.paths(Predicates.not(PathSelectors.regex("/dump.*")))
.paths(Predicates.not(PathSelectors.regex("/auditevents.*")))
.paths(Predicates.not(PathSelectors.regex("/docs.*"))).paths(Predicates.not(PathSelectors.regex("/archaius.*")))
.paths(Predicates.not(PathSelectors.regex("/features.*")))
.paths(Predicates.not(PathSelectors.regex("/pause.*"))).paths(Predicates.not(PathSelectors.regex("/refresh.*")))
.paths(Predicates.not(PathSelectors.regex("/resume.*")))
.paths(Predicates.not(PathSelectors.regex("/actuator.*")))
.paths(Predicates.not(PathSelectors.regex("/jolokia.*")))
.paths(Predicates.not(PathSelectors.regex("/loggers.*")))
.paths(Predicates.not(PathSelectors.regex("/restart.*")))
.paths(Predicates.not(PathSelectors.regex("/service-registry/instance-status.*")))
.paths(Predicates.not(PathSelectors.regex("/logfile.*")))
.paths(Predicates.not(PathSelectors.regex("/channels.*"))).paths(Predicates.not(PathSelectors.regex("/bus.*")))
.paths(Predicates.not(PathSelectors.regex("/heapdump.*"))).build();
}

/**
* Swagger2主界面信息,描述api的基本信息用于展示
*
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("knot服务接口定义和规范").description("knot服务接口定义和规范")
.termsOfServiceUrl("http://****.com/").contact(new Contact("jjzhao@****.com", "", "")).version("1.0")
.license("版权所有 ©***信息科技有限公司").build();
}

}

3.在controller类中使用swagger标签：