溫馨提示×

SpringBoot中如何集成Swagger文檔

小億
109
2024-04-18 16:09:14
欄目: 編程語言

要在Spring Boot項目中集成Swagger文檔,可以按照以下步驟操作:

  1. 添加Swagger依賴: 在項目的pom.xml文件中添加Swagger的依賴:
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
  1. 創建Swagger配置類: 在項目中創建一個Swagger配置類,用于配置Swagger的相關信息,例如文檔標題、描述、版本等。示例代碼如下:
@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API Documentation")
                .description("Swagger documentation for API endpoints")
                .version("1.0")
                .build();
    }
}
  1. 啟用Swagger: 在Spring Boot的啟動類上使用@EnableSwagger2注解來啟用Swagger:
@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
  1. 訪問Swagger文檔: 啟動Spring Boot應用程序后,可以通過訪問http://localhost:8080/swagger-ui/來查看生成的Swagger文檔界面,其中包含了API的各個接口和相關信息。

通過以上步驟,就可以在Spring Boot項目中集成Swagger文檔并查看API接口的詳細信息。

0
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女