快捷導(dǎo)航

SpringBoot整合Swagger3生成接口文檔過程解析

更新時間：2020年07月21日 10:50:42 作者：陳大帥哥Ray

這篇文章主要介紹了SpringBoot整合Swagger3生成接口文檔過程解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下

　　前后端分離的項目，接口文檔的存在十分重要。與手動編寫接口文檔不同，swagger是一個自動生成接口文檔的工具，在需求不斷變更的環(huán)境下，手動編寫文檔的效率實在太低。與新版的swagger3相比swagger2配置更少，使用更加方便。

一、pom文件中引入Swagger3依賴

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-boot-starter</artifactId>
   <version>3.0.0</version>
</dependency>

二、Application上面加入@EnableOpenApi注解

@EnableOpenApi
@SpringBootApplication
@MapperScan(basePackages = {"cn.ruiyeclub.dao"})
public class Swagger3Application {
  public static void main(String[] args) {
    SpringApplication.run(Swagger3Application.class, args);
  }
}

三、Swagger3Config的配置

@Configuration
public class Swagger3Config {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.OAS_30)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Swagger3接口文檔")
        .description("更多請咨詢服務(wù)開發(fā)者Ray。")
        .contact(new Contact("Ray。", "http://www.ruiyeclub.cn", "ruiyeclub@foxmail.com"))
        .version("1.0")
        .build();
  }
}

四、Swagger注解的使用說明

@Api：用在請求的類上，表示對類的說明
  tags="說明該類的作用，可以在UI界面上看到的注解"
  value="該參數(shù)沒什么意義，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在請求的方法上，說明方法的用途、作用
  value="說明方法的用途、作用"
  notes="方法的備注說明"

@ApiImplicitParams：用在請求的方法上，表示一組參數(shù)說明
  @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個請求參數(shù)的各個方面
    name：參數(shù)名
    value：參數(shù)的漢字說明、解釋
    required：參數(shù)是否必須傳
    paramType：參數(shù)放在哪個地方
      · header --> 請求參數(shù)的獲?。篅RequestHeader
      · query --> 請求參數(shù)的獲取：@RequestParam
      · path（用于restful接口）--> 請求參數(shù)的獲?。篅PathVariable
      · body（不常用）
      · form（不常用）  
    dataType：參數(shù)類型，默認(rèn)String，其它值dataType="Integer"    
    defaultValue：參數(shù)的默認(rèn)值

@ApiResponses：用在請求的方法上，表示一組響應(yīng)
  @ApiResponse：用在@ApiResponses中，一般用于表達一個錯誤的響應(yīng)信息
    code：數(shù)字，例如400
    message：信息，例如"請求參數(shù)沒填好"
    response：拋出異常的類

@ApiModel：用于響應(yīng)類上，表示一個返回響應(yīng)數(shù)據(jù)的信息
      （這種一般用在post創(chuàng)建的時候，使用@RequestBody這樣的場景，
      請求參數(shù)無法使用@ApiImplicitParam注解進行描述的時候）
  @ApiModelProperty：用在屬性上，描述響應(yīng)類的屬性

Controller層的配置：

@Api(tags = "用戶信息管理")
@RestController
@RequestMapping("userRecord")
public class UserRecordController extends ApiController {
  /**
   * 服務(wù)對象
   */
  @Resource
  private UserRecordService userRecordService;

  /**
   * 分頁查詢所有數(shù)據(jù)
   * @param page    分頁對象
   * @param userRecord 查詢實體
   * @return 所有數(shù)據(jù)
   */
  @ApiOperation("分頁查詢所有數(shù)據(jù)")
  @GetMapping("page")
  public R selectAll(Page<UserRecord> page, UserRecord userRecord) {
    return success(this.userRecordService.page(page, new QueryWrapper<>(userRecord)));
  }

  /**
   * 通過主鍵查詢單條數(shù)據(jù)
   * @param id 主鍵
   * @return 單條數(shù)據(jù)
   */
  @ApiOperation("通過主鍵查詢單條數(shù)據(jù)")
  @GetMapping("{id}")
  public R selectOne(@PathVariable Serializable id) {
    return success(this.userRecordService.getById(id));
  }

  /**
   * 新增數(shù)據(jù)
   * @param userRecord 實體對象
   * @return 新增結(jié)果
   */
  @ApiOperation("新增數(shù)據(jù)")
  @PostMapping("insert")
  public R insert(@RequestBody UserRecord userRecord) {
    return success(this.userRecordService.save(userRecord));
  }

  /**
   * 修改數(shù)據(jù)
   * @param userRecord 實體對象
   * @return 修改結(jié)果
   */
  @ApiOperation("修改數(shù)據(jù)")
  @PutMapping("update")
  public R update(@RequestBody UserRecord userRecord) {
    return success(this.userRecordService.updateById(userRecord));
  }

  /**
   * 刪除數(shù)據(jù)
   * @param idList 主鍵結(jié)合
   * @return 刪除結(jié)果
   */
  @ApiOperation("刪除數(shù)據(jù)")
  @DeleteMapping("delete")
  public R delete(@RequestParam("idList") List<Long> idList) {
    return success(this.userRecordService.removeByIds(idList));
  }
}

五、Swagger界面效果