使用 Swagger 来进行前后端协作

配置 Swagger

• 文档与 Github 库

  • Swagger规范

  • 基于 Spring 生态系统的 Swagger 规范的实现：springfox-swagger2

  • 封装好的UI：springfox-swagger-ui

  • 官方英文文档：Springfox Reference Documentation

• 引入依赖

  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.8.0</version>
  </dependency>
  
  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.8.0</version>
  </dependency>
  

• 开启注解

  在 Application 上添加注解 @EnableSwagger2

具体使用方式

• 需要注解的字段

  • ApiOperation

    因为使用前后端分离，推荐所有参数为 json格式 ，所以在 notes 里面注明 需要 Mock 的静态输入。

    @ApiOperation(value = "测试接口", notes = "示例数据：\n" + test)
    @PostMapping("/test2")
    public JSONObject