SpringBoot內建Swagger2接口管理案例

一、Swagger2簡介

1、Swagger2優點

整合到Spring Boot中，建構強大RESTful API文檔。省去接口文檔管理工作，修改代碼，自動更新，Swagger2也提供了強大的頁面測試功能來調試RESTful API。

2、Swagger2常用注解

Api：修飾整個類，描述Controller的作用
ApiOperation：描述一個類的一個方法，或者說一個接口
ApiParam：單個參數描述
ApiModel：用對象來接收參數
ApiProperty：用對象接收參數時，描述對象的一個字段
ApiResponse：HTTP響應其中1個描述
ApiResponses：HTTP響應整體描述
ApiIgnore：使用該注解忽略這個API
ApiError ：發生錯誤傳回的資訊
ApiImplicitParam：一個請求參數
ApiImplicitParams：多個請求參數           

二、SpringBoot2整合

1、核心依賴

spring-boot：2.1.3.RELEASE
swagger：2.6.1           

2、Swagger2 配置

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;
/**
 * Swagger 配置檔案
 */
@Configuration
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.swagger.two"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot利用Swagger建構API文檔")
                .description("使用RestFul風格, 建立人：知了一笑")
                .termsOfServiceUrl("https://github.com/cicadasmile")
                .version("version 1.0")
                .build();
    }
}           

3、啟動類添加注解

@EnableSwagger2
@SpringBootApplication
public class SwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SwaggerApplication.class,args) ;
    }
}           

4、啟動效果圖

三、增删改查案例

1、添加使用者

(1)、代碼塊

@ApiOperation(value="添加使用者", notes="建立新使用者")
@ApiImplicitParam(name = "user", value = "使用者詳細實體user", required = true, dataType = "User")
@RequestMapping(value = "/addUser", method = RequestMethod.POST)
public ResponseEntity<JsonResult> addUser (@RequestBody User user){
    JsonResult result = new JsonResult();
    try {
        users.put(user.getId(), user);
        result.setResult(user.getId());
        result.setStatus("ok");
    } catch (Exception e) {
        result.setResult("服務異常");
        result.setStatus("500");
        e.printStackTrace();
    }
    return ResponseEntity.ok(result);
}           

(2)、效果圖

2、使用者清單

(1)、代碼塊

@ApiOperation(value="使用者清單", notes="查詢使用者清單")
@RequestMapping(value = "/getUserList", method = RequestMethod.GET)
public ResponseEntity<JsonResult> getUserList (){
    JsonResult result = new JsonResult();
    try {
        List<User> userList = new ArrayList<>(users.values());
        result.setResult(userList);
        result.setStatus("200");
    } catch (Exception e) {
        result.setResult("服務異常");
        result.setStatus("500");
        e.printStackTrace();
    }
    return ResponseEntity.ok(result);
}           

(2)、效果圖

3、使用者查詢

(1)、代碼塊

@ApiOperation(value="使用者查詢", notes="根據ID查詢使用者")
@ApiImplicitParam(name = "id", value = "使用者ID", required = true, dataType = "Integer", paramType = "path")
@RequestMapping(value = "/getUserById/{id}", method = RequestMethod.GET)
public ResponseEntity<JsonResult> getUserById (@PathVariable(value = "id") Integer id){
    JsonResult result = new JsonResult();
    try {
        User user = users.get(id);
        result.setResult(user);
        result.setStatus("200");
    } catch (Exception e) {
        result.setResult("服務異常");
        result.setStatus("500");
        e.printStackTrace();
    }
    return ResponseEntity.ok(result);
}           

(2)、效果圖

4、更新使用者

(1)、代碼塊

@ApiOperation(value="更新使用者", notes="根據Id更新使用者資訊")
@ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "使用者ID", required = true, dataType = "Long",paramType = "path"),
        @ApiImplicitParam(name = "user", value = "使用者對象user", required = true, dataType = "User")
})
@RequestMapping(value = "/updateById/{id}", method = RequestMethod.PUT)
public ResponseEntity<JsonResult> updateById (@PathVariable("id") Integer id, @RequestBody User user){
    JsonResult result = new JsonResult();
    try {
        User user1 = users.get(id);
        user1.setUsername(user.getUsername());
        user1.setAge(user.getAge());
        users.put(id, user1);
        result.setResult(user1);
        result.setStatus("ok");
    } catch (Exception e) {
        result.setResult("服務異常");
        result.setStatus("500");
        e.printStackTrace();
    }
    return ResponseEntity.ok(result);
}           

(2)、效果圖

5、删除使用者

(1)、代碼塊

@ApiOperation(value="删除使用者", notes="根據id删除指定使用者")
@ApiImplicitParam(name = "id", value = "使用者ID", required = true, dataType = "Long", paramType = "path")
@RequestMapping(value = "/deleteById/{id}", method = RequestMethod.DELETE)
public ResponseEntity<JsonResult> deleteById (@PathVariable(value = "id") Integer id){
    JsonResult result = new JsonResult();
    try {
        users.remove(id);
        result.setResult(id);
        result.setStatus("ok");
    } catch (Exception e) {
        result.setResult("服務異常");
        result.setStatus("500");
        e.printStackTrace();
    }
    return ResponseEntity.ok(result);
}           

(2)、效果圖

參考源碼：https://gitee.com/cicadasmile/middle-ware-parent/tree/master/ware04-swagger-two

結束語

目前市面上大部分項目都是前後端分離，前後端接口聯調尤其重要，Swagger接口管理作為前後端溝通的橋梁，此案例抛磚迎玉，任何接口管理的基礎就是swagger接口管理，市面上大部分接口管理都是封裝swagger！

開源分享不易，感謝大家的支援，多關注，點贊。後續也會分享更多的幹貨和技術資訊，您的閱讀就是對小編的支援，再次感謝各位老鐵！