@[toc]

公司主營業(yè)務(wù)：成都網(wǎng)站制作、做網(wǎng)站、移動(dòng)網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳，提高企業(yè)的競爭能力。創(chuàng)新互聯(lián)是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊(duì)。公司秉承以“開放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化，感謝他們對(duì)我們的高要求，感謝他們從不同領(lǐng)域給我們帶來的挑戰(zhàn)，讓我們激情的團(tuán)隊(duì)有機(jī)會(huì)用頭腦與智慧不斷的給客戶帶來驚喜。創(chuàng)新互聯(lián)推出峰峰礦免費(fèi)做網(wǎng)站回饋大家。

簡介

優(yōu)點(diǎn)

后端根據(jù)swagger語法，自動(dòng)生成漂亮規(guī)范的接口文檔。

做交互測(cè)試。

劣勢(shì)

侵入式的，影響程序運(yùn)行，尤其是傳參的時(shí)候。

注意

swagger 分1.2版本和2.0版本，差異較大。swagger1.2 即 swagger-ui ； swagger2.0 即 springfox-swagger 。本文介紹的使用方式是新的版本，即 springfox-swagger 。

發(fā)布生產(chǎn)，關(guān)閉swagger，以防泄漏項(xiàng)目接口文檔，被***

引入swagger組件

pom.xml中加入

    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2

代碼實(shí)戰(zhàn)

我看很多博主說swagger的配置代碼要和項(xiàng)目啟動(dòng)文件在同級(jí)目錄，即如下

但是，移入config目錄下，經(jīng)過測(cè)試，也是正常的，那這樣就看個(gè)人習(xí)慣了。

DemoApplication.java

package com.example;

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

//通過 @Configuration 注解，讓 Spring 來加載該類配置。
//再通過 @EnableSwagger2 注解來啟用 Swagger2。
@Configuration
@EnableSwagger2
public class DemoSwagger {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 指定要掃描的包路徑
             .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("項(xiàng)目api文檔")
                .description("swagger接入教程")
                .version("1.0")
                .build();
    }
}

因?yàn)橹耙呀?jīng)配置好了spring security，所以瀏覽器網(wǎng)址中輸入 http://localhost:8080/swagger-ui.html 后，會(huì)被攔截住，輸入之前配置好的用戶密碼后，效果如下所示；

因?yàn)橹皽y(cè)試用戶登錄，用戶權(quán)限，所以controller里面已經(jīng)有了一些接口方法，但是就讓它這樣默認(rèn)，顯然用戶體驗(yàn)不好，所以在之前的userController里繼續(xù)加上swagger的注解。

@Api：用在類上，說明該類的作用。

@ApiOperation：說明該方法的作用。

具體而更細(xì)致的注解參見官方文檔 常用注解說明 。

UserController.java

package com.example.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("user")
@Api(value = "用戶模塊說明", description = "提供用戶的增、刪、改、查")
public class UserController {

    @RequestMapping(value = "/addUser", method = RequestMethod.GET)
    @ResponseBody
    @ApiOperation(value = "添加用戶", notes = "放一些信息，供測(cè)試判斷")
    String addUser() {
        return "這是添加用戶?。?！";
    }

    @RequestMapping(value = "/deleteUser", method = RequestMethod.POST)
    @ResponseBody
    @ApiOperation(value = "刪除用戶", notes = "放一些信息，供測(cè)試判斷")
    String deleteUser() {
        return "這是刪除用戶?。?！";
    }

    @RequestMapping("/updateUser")
    @ResponseBody
    @ApiOperation(value = "修改用戶", notes = "放一些信息，供測(cè)試判斷")
    String updateUser() {
        return "這是修改用戶?。?！";
    }

    @RequestMapping(value = "/findAllUsers", method = RequestMethod.PUT)
    @ResponseBody
    @ApiOperation(value = "查詢用戶", notes = "放一些信息，供測(cè)試判斷")
    String findAllUsers() {
        return "這是查詢用戶?。?！";
    }

}

效果圖如下


具體打開某一條，如下

很明顯，有了中文注釋，文檔可讀性更強(qiáng)。

要說明的是，平時(shí)寫 @RequestMapping 注解的時(shí)候，我通常會(huì)簡寫，如上demo中的修改用戶方法。但是swagger是侵入式的，如果未指定 RequestMethod 類型，就會(huì)把一大堆都列出來，如GET，HEAD，POST，PUT，DELETE，OPTIONS，PATCH ，而其他指定好的，則是一條。