1. 程式人生 > >Spring Boot 整合 swagger2 自動生成 RESTFul API 文檔

Spring Boot 整合 swagger2 自動生成 RESTFul API 文檔

pat turn ket config 文件 pen 用戶 配置文件 方式

1)首先編輯pom.xml添加依賴

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
</dependency>

2)創建Swagger配置文件

package pro.kkpai.springbootswagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2
public class SwaggerConfig { @Bean public Docket RestApi(){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("pro.kkpai.springbootswagger.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() //標題 .title("這是Swagger的RESTFul API") //描述 .description("一個用戶管理系統的RESTFul API") //聯系方式 .contact(new Contact("kkpai", "https://kkpai.pro", "[email protected]")) //服務條款url .termsOfServiceUrl("https://kkpai.pro")
          
//版本 .version("1.0") .build(); } }

3)Controller層類添加註解

  @Api

未完。。。

Spring Boot 整合 swagger2 自動生成 RESTFul API 文檔