当前位置：首页 > article >正文

杂七杂八之Swagger环境搭建（Java版本）

article 2024/11/14 11:12:33

杂七杂八之Swagger环境搭建（Java版本）

在现代Web开发中，API文档的生成和维护是一个非常重要的环节。Swagger是一个强大的工具，它能够帮助开发者自动生成RESTful API的文档，并提供了一个用户友好的界面来测试这些API。本文将详细介绍如何在Java项目中搭建Swagger环境，包括所需的依赖、配置步骤以及如何使用Swagger UI来查看和测试API。

环境准备

在开始之前，确保你的开发环境中已经安装了以下软件：
● Java Development Kit (JDK) 1.8 或更高版本
● Maven 3.6.1（自己的应用环境）
● 一个支持Java的IDE，如 IntelliJ IDEA 或 Eclipse，本人使用IDEA

添加Swagger依赖

Maven项目

如果你的项目是基于Maven的，可以在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>

Gradle项目

如果你的项目是基于Gradle的，可以在build.gradle文件中添加以下依赖：

dependencies {
    implementation 'io.springfox:springfox-swagger2:2.9.2'
    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
}

配置Swagger

创建Swagger配置类

在你的Spring Boot项目中，创建一个新的配置类来启用Swagger。例如，可以创建一个名为SwaggerConfig.java的类：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
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 Sam Zhang
 * @date 2024-11-06 09:45:45
 * @since 0.0.1
 * 注释：swagger接口注释
 */

@EnableSwagger2
@Configuration
//是否开启swagger，正式环境一般是需要关闭的（避免不必要的漏洞暴露！），可根据springboot的多环境配置进行设置
public class Swagger2Config implements WebMvcConfigurer {
    // swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.demo.llmanalysis"))
                .paths(PathSelectors.any())
                .build();
    }
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/static/");
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
    // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title("JMeter日志错误日志大模型分析服务")
                // 创建人信息
                .contact(new Contact("Sam Zhang",  "https://blog.csdn.net/u012151594?type=blog",  "Sam_Zhang@XXXXXX.com"))
                // 版本号
                .version("1.0")
                // 描述
                .description("LLMAnalysis API 描述")
                .build();
    }
}