Swagger-ui与springBoot的结合

最新推荐文章于 2024-05-21 22:48:51 发布

ZeroMaster

最新推荐文章于 2024-05-21 22:48:51 发布

阅读量500

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/wszhm123/article/details/79641072

springBoot 同时被 3 个专栏收录

19 篇文章

订阅专栏

springboot

16 篇文章

订阅专栏

swagger

2 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括引入依赖、配置启动类及使用注解等步骤，助您轻松搭建API文档。

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

在我们开发的时候，测试接口很多时候都需要写测试类来测试，但是现在有一个非常方便的工具用于我们测试我们开发的接口是否可用，那就是swagger-ui,他的地址是：https://swagger.io/download-swagger-ui/。

swagger-ui和springBoot的搭配，特别方便，操作步骤如下。

1：在pom.xml中准备相应的jar包地址：

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

2：和springBoot的启动代码同一层添加一个swagger2.java文件用于说明我们启动的内容，代码如下：

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

@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.zhm.springboot.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("仅用于开发环境")
.termsOfServiceUrl("http://97kankan.xin/")
.contact("walle")
.version("1.0")
.build();
}