swagger整合springboot的使用

什么是swagger?

Swagger 是一個規范且完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。

Swagger 的目標是對 REST API 定義一個標准且和語言無關的接口，可以讓人和計算機擁有無須訪問源碼、文檔或網絡流量監測就可以發現和理解服務的能力。當通過 Swagger 進行正確定義，用戶可以理解遠程服務並使用最少實現邏輯與遠程服務進行交互。與為底層編程所實現的接口類似，Swagger 消除了調用服務時可能會有的猜測。

swagger整合springboot的使用:

   一、引入依賴

 

        <!--添加Swagger依賴 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>

        <!--添加Swagger-UI依賴 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

 

二、編寫配置類

package com.liusha.swagger.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.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration  //標記為配置類
@EnableSwagger2  //開啟Swagger在線接口文檔
public class SwaggerConfig {
    /**
     * 添加摘要信息(Docket)
     * .groupName("XXXX")配置這個Docket的組名
     */
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("組名:")
                .apiInfo(new ApiInfoBuilder()
                        .title("標題:此處是配置UI界面顯示的標題信息")
                        .description("描述：這里配置的是UI界面顯示的對這個接口文檔的描述信息")
                        //new Contact()  第一個參數是創建者,第二個是連接地址(可以不配),第三個參數是郵箱(可以不配)
                        .contact(new Contact("流-沙", "https://www.cnblogs.com/liusha-1/", "[e-mail]"))
                        .version("版本號:1.0")
                        .build())
                .select()
                //掃描Api接口的包監聽是哪一個路徑的
                .apis(RequestHandlerSelectors.basePackage("com.liusha.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

三、監聽的controller類

package com.liusha.swagger.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 *  @ApiOperation()配置這個接口的描述信息
 */
@RestController
public class TestController {

    @ApiOperation("測試SwaggerApi的接口")
    @RequestMapping("/test")
    public String test(){
        return "hello swagger";
    }
}

四、運行之后點擊http://localhost:8080/swagger-ui.html打開SwaggerUI界面如下: