1. 程式人生 > >Spring-Boot 線上Swagger

Spring-Boot 線上Swagger

1、新增依賴

      <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger2</artifactId>
          <version>${swagger.version}</version>
      </dependency>
      <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger-ui</artifactId>
          <version>${swagger.version}</version>
      </dependency>

2、在spring-boot啟動Application中新增@EnableSwagger2註解

         此方法採用預設的Swagger頁面

         也可自定義Swagger

                  在spring-boot啟動的Application同級目錄下新建Swagger2類

package com.springboot.controller;

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 Swagger2 {
    //swagger2的配置檔案,這裡可以配置swagger2的一些基本的內容,比如掃描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            //為當前包路徑
            .apis(RequestHandlerSelectors.basePackage("com.springboot.controller"))
            .paths(PathSelectors.any())
            .build();
    }
    //構建 api文件的詳細資訊函式,注意這裡的註解引用的是哪個
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            //頁面標題
            .title("Spring Boot 測試使用 Swagger2 構建RESTful API")
            //建立人
            .contact(new Contact("曲樂歐", "https://gitee.com/QuLeOu/spring-boot", "
[email protected]
")) //版本號 .version("1.0") //描述 .description("API 描述") .build(); } }