SpringBoot＋Swagger-ui如何自動(dòng)生成API文檔

這篇文章主要介紹SpringBoot＋Swagger-ui如何自動(dòng)生成API文檔，文中介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們一定要看完！

創(chuàng)新互聯(lián)建站專注于企業(yè)成都全網(wǎng)營銷推廣、網(wǎng)站重做改版、磐石網(wǎng)站定制設(shè)計(jì)、自適應(yīng)品牌網(wǎng)站建設(shè)、H5建站、商城開發(fā)、集團(tuán)公司官網(wǎng)建設(shè)、成都外貿(mào)網(wǎng)站制作、高端網(wǎng)站制作、響應(yīng)式網(wǎng)頁設(shè)計(jì)等建站業(yè)務(wù)，價(jià)格優(yōu)惠性價(jià)比高，為磐石等各大城市提供網(wǎng)站開發(fā)制作服務(wù)。

什么是Swagger

Swagger是一個(gè)Restful風(fēng)格接口的文檔在線自動(dòng)生成和測試的框架

官網(wǎng)：http://swagger.io

官方描述：The World's Most Popular Framework for APIs.

先看一下 swagger-ui 生成的api 的效果吧

然后我們打開查詢所有用戶的api 看到api 內(nèi)容

然后在服務(wù)器運(yùn)行的狀態(tài)下點(diǎn)擊 try it out 測試查詢功能

接著打開新增的api 查看

好了這個(gè)就是自動(dòng)生成的api 效果。接下來我們就看怎么在我們的項(xiàng)目中使用swagger-ui 吧

springboot 集成 swagger -ui

1、添加依賴

      io.springfox
      springfox-swagger2
      2.2.2
    
    
      io.springfox
      springfox-swagger-ui
      2.2.2

2、編寫配置文件

在application 同級(jí)目錄新建 Swagger2 文件

package com.abel.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;
/**
 * Created by yangyibo on 2018/9/7.
 */
@Configuration
@EnableSwagger2
public class Swagger2 {
  /**
   * 創(chuàng)建API應(yīng)用
   * apiInfo() 增加API相關(guān)信息
   * 通過select()函數(shù)返回一個(gè)ApiSelectorBuilder實(shí)例,用來控制哪些接口暴露給Swagger來展現(xiàn)，
   * 本例采用指定掃描的包路徑來定義指定要建立API的目錄。
   * @return
   */
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.abel.example.controller"))
        .paths(PathSelectors.any())
        .build();
  }
  /**
   * 創(chuàng)建該API的基本信息（這些基本信息會(huì)展現(xiàn)在文檔頁面中）
   * 訪問地址：http://項(xiàng)目實(shí)際地址/swagger-ui.html
   * @return
   */
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Spring Boot中使用Swagger2構(gòu)建RESTful APIs")
        .description("更多請(qǐng)關(guān)注https://blog.csdn.net/u012373815")
        .termsOfServiceUrl("https://blog.csdn.net/u012373815")
        .contact("abel")
        .version("1.0")
        .build();
  }
}

3、在controller上添加注解，自動(dòng)生成API

注意：

package com.abel.example.controller;
import javax.servlet.http.HttpServletRequest;
import java.util.Map;
import com.abel.example.bean.User;
import io.swagger.annotations.*;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import com.abel.example.service.UserService;
import com.abel.example.util.CommonUtil;
@Controller
@RequestMapping(value = "/users")
@Api(value = "用戶的增刪改查")
public class UserController {
  @Autowired
  private UserService userService;
  /**
   * 查詢所有的用戶
   * api :localhost:8099/users
   * @return
   */
  @RequestMapping(method = RequestMethod.GET)
  @ResponseBody
  @ApiOperation(value = "獲取用戶列表，目前沒有分頁")
  public ResponseEntity