快捷導(dǎo)航

SpringBoot結(jié)合Swagger2自動(dòng)生成api文檔的方法

更新時(shí)間：2019年05月12日 11:49:04 作者：窮則獨(dú)善其身_達(dá)則兼濟(jì)天下

這篇文章主要介紹了SpringBoot結(jié)合Swagger2自動(dòng)生成api文檔的方法，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

首先在pom.xml中添加如下依賴(lài),其它web,lombok等依賴(lài)自行添加

  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.7.0</version>
    </dependency>

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

SwaggerConfig.java是swagger2的配置類(lèi)

@Configuration
@EnableSwagger2
public class SwaggerConfig {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("cn.niit.controller"))
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Spring Boot中使用Swagger2")
        .description("首次嘗試自動(dòng)生成api文檔為后期的前后端分離開(kāi)發(fā)做準(zhǔn)備")
        .termsOfServiceUrl("https://www.jianshu.com/u/2f60beddf923")
        .contact("WEN")
        .version("1.0")
        .build();
  }
}

實(shí)體類(lèi)User.java

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
  public User(String userName, String password) {
    this.userName = userName;
    this.password = password;
  }

  private Integer id;
  private String userName;
  private String password;
}

新建一個(gè)控制類(lèi)UserController.java，類(lèi)下有個(gè)方法getAllUser

@RestController
@Api(description = "用戶(hù)管理")
@RequestMapping(value = "/hello",produces = APPLICATION_JSON_VALUE)
public class UserController {

  List<User>lists=new ArrayList<>();

  @GetMapping(value ="getAllUser" )
  @ApiOperation(value = "用戶(hù)列表",notes = "查詢(xún)所有已注冊(cè)過(guò)的用戶(hù)詳細(xì)信息")
  public List<User> getAllUser()
  {
  lists.add(new User("wen","999"));
  lists.add(new User(2,"qian","666"));
  return lists;
  }
}

點(diǎn)擊localhost:8888/swagger-ui.html(我在application.propertise中的server.port=8888)

在類(lèi)中再添加一個(gè)方法addUser

 @PostMapping(value = "addUser")
  public User addUser(User user)
  {
    return user;
  }

實(shí)體類(lèi)User.java的屬性上添加如下注解

@ApiModelProperty(value = "用戶(hù)ID")
  private Integer id;
  @ApiModelProperty(value = "用戶(hù)名")
  private String userName;
  @ApiModelProperty(value = "密碼")
  private String password;

創(chuàng)建用戶(hù)時(shí)有些字段我們并不需要，可以加入如下注解

@ApiModelProperty(hidden = true)

在類(lèi)中再添加一個(gè)根據(jù)用戶(hù)id查詢(xún)用戶(hù)的方法

  @GetMapping(value = "getUserById/{id}")
  public User getUserById(@ApiParam(value = "用戶(hù)ID")@PathVariable(value = "id")String id)
  {
    return new User(id,"步驚云","passwordjava");
  }

漢化成中文文檔

在swagger相關(guān)的jar包

把META-INF這個(gè)包復(fù)制到你當(dāng)前項(xiàng)目的resources目錄下

這些是關(guān)鍵，剩下多余的包可自行刪除

在swagger-ui.html的<head>部分添加如下代碼

<!--國(guó)際化操作：選擇中文版 -->
 <script src='webjars/springfox-swagger-ui/lang/translator.js' type='text/javascript'></script>
 <script src='webjars/springfox-swagger-ui/lang/zh-cn.js' type='text/javascript'></script>

漢化完成，我們也可以在zh_cn.js中自定義中文名稱(chēng)