1.添加pom文件依赖
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.3.6</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.5.0</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
<version>2.5.0</version>
</dependency>
2.新建SwaggerConfig类
@Configuration
public class SwaggerConfig {
@Bean
public OpenAPI api() {
// List<Parameter> sw = new ArrayList<Parameter>();
return new OpenAPI()
.info(new Info()
.title("My API")
.version("1.0")
.description("This is a sample Spring boot REST API created using Swagger")
.license(new License().name("Apache 2.0").url("https://www.apache.org/licenses/LICENSE-2.0")))
.externalDocs(new ExternalDocumentation().description("Design documentation")
.url("http://www.example.com/docs"));
}
3.确保 application.properties 或 application.yml文件中没有禁用 Swagger UI
springdoc.swagger-ui.enabled=true
4.controller类或者接口相关类加上相应注解
5.启动spring boot ,访问 Swagger UI
Swagger 2常用注解
Swagger3 常用注解及含义
