溫馨提示×

SpringBoot中怎么使用Swagger生成API文檔

小億
84
2024-04-18 15:59:22
欄目: 編程語言

在Spring Boot中使用Swagger生成API文檔主要分為以下幾個步驟：

  1. 添加Swagger依賴：在pom.xml文件中添加Swagger相關的依賴，例如：
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
  1. 配置Swagger：創(chuàng)建一個配置類，配置Swagger的一些基本信息，例如：
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}
  1. 運行應用程序：啟動Spring Boot應用程序，訪問http://localhost:8080/swagger-ui/index.html即可查看生成的API文檔。

通過以上步驟，就可以在Spring Boot應用中集成Swagger并生成API文檔了。Swagger還提供了很多自定義配置選項，可以根據(jù)實際需求進行配置。

0 踩