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#/

相关推荐
锋行天下8 小时前
langgraph全栈项目(一)
前端·人工智能·后端
学长毕设8 小时前
基于SpringBoot的游戏攻略社区交流系统-附源码
spring boot·后端·游戏
程序员cxuan8 小时前
不得了,Google 造反了,Opus 5.5 又被干了
人工智能·后端·程序员
叼烟扛炮8 小时前
[LangChain] 学习笔记(15):为什么你的重试没用——429、抖动、fallback 与熔断
java·服务器·前端
Csvn9 小时前
Nginx 缓存体系:三层 key、七态 X-Cache-Status 与锁/stale 策略
后端·nginx
文丑颜不良啊9 小时前
LeetCode3401~3420题目解析
java·leetcode
时间海87110 小时前
前端表单如何防止重复提交
后端
稀土蚯蚓10 小时前
OLAP 分析引擎:StarRocks、Doris、ES、ClickHouse,存算分离、列式存储 Parquet
后端
旋律41410 小时前
序列化与反序列化
后端
文丑颜不良啊11 小时前
LeetCode3421~3440题目解析
java·leetcode