SpringBoot3使用Swagger3
要在Spring Boot 3中使用Swagger 3,你需要按照以下步骤操作:
- 在
pom.xml
中添加Swagger 3的依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
- 配置Swagger 3。创建一个配置类,如
SwaggerConfig.java
:
import io.swagger.v3.oas.models.OpenAPI;
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 customOpenAPI() {
return new OpenAPI()
.info(new Info()
.title("Your API Title")
.description("Your API Description")
.version("1.0.0")
.license(new License().name("Apache 2.0").url("http://springdoc.org")));
}
}
- 确保你的Spring Boot应用启动类上有
@EnableSwagger2
注解:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class YourApplication {
public static void main(String[] args) {
SpringApplication.run(YourApplication.class, args);
}
}
- 访问Swagger UI页面。启动你的Spring Boot应用后,打开浏览器访问:
http://localhost:8080/swagger-ui/index.html
。
确保你的Spring Boot应用配置了对应的端口(默认是8080),如果不是,可能需要修改为实际运行的端口。
以上步骤是基于Spring Boot 3和Swagger 3的基本配置。根据你的具体需求,可能需要调整配置类中的OpenAPI
的详细信息,比如添加更多的API信息,定制文档等。
评论已关闭