Spring Boot 3项目使用Swagger3教程

Spring Boot 3项目使用Swagger3教程

Swagger:自动生成接口文档

添加依赖(pom.xml)

xml 复制代码
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>4.1.0</version>
</dependency>

配置Swagger

Spring Boot项目中创建一个配置类SwaggerConfig,并添加Swagger的配置信息。

java 复制代码
import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("标题")
                        .contact(new Contact())
                        .description("我的API文档")
                        .version("v1")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("外部文档")
                        .url("https://springshop.wiki.github.org/docs"));
    }
}

接口注释

java 复制代码
import io.swagger.v3.oas.annotations.Operation;
public class StudentContraller {
    @Operation(summary = "获取学生信息")
    @GetMapping("/student/{id}/")
    public Response<StudentDTO> getStudentById(@PathVariable long id){}
}

访问

http://localhost:8080/swagger-ui/index.html#/

相关推荐
wenb1n3 分钟前
【安全漏洞】隐藏在HTTP请求中的“隐形杀手”:Host头攻击漏洞深度剖析
java·后端
snakeshe10103 分钟前
Java开发中的最佳实践与代码优化技巧
后端
不失者4 分钟前
关于AI时代的一点思考
人工智能·后端·程序员
好奇心笔记4 分钟前
D1数据库实战:SQLite在云端的华丽转身
人工智能·后端
Ray665 分钟前
es-plugin:lock:mmap+mlock
后端
snakeshe10109 分钟前
H2数据库入门指南:从建库到操作的全流程实践
后端
字节跳跃者10 分钟前
SpringBoot AOP + Redis 延时双删功能实战
java·后端
一只叫煤球的猫14 分钟前
你真的处理好 null 了吗?——11种常见但容易被忽视的空值处理方式
java·后端·面试
snakeshe101016 分钟前
Java对象核心剖析:从创建到回收的生命周期全解
后端
在钱塘江17 分钟前
《On Java进阶卷》- 笔记-2-对象传递和返回
java·后端