使用swagger自動生成html文件

本節內容

• 使用swagger自動生成html文件
• 使用WireMock快速偽造restful服務

前後分離並行開發的時候（當然不是一個人從前到後都幹那種）；那麼提供文件就很有必要了。

光看文件不是那麼的直觀。偽造服務可能更直觀（個人感覺而言，文件詳細，自己在postman這種工具中去呼叫也是一樣的）

初體驗

新增兩個依賴

// 掃描程式生成文件資料
// http://springfox.github.io/springfox/docs/current/
// https://mvnrepository.com/artifact/io.springfox/springfox-swagger2
 

compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'
// 提供視覺化介面
// https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui
compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'

添加註解開啟swagger

@EnableSwagger2
public class DemoApplication {

啟動程式後，訪問：http://localhost:8080/swagger-ui.html

可以點選Try it out按鈕發起請求，然後在介面上會把響應結果返回；

這樣看的確挺方便的；

使用註解自定義資訊

定義api描述

@ApiOperation(value = "使用者查詢服務")  // 方法描述
public List<User> query(UserQueryCondition condition) {

定義請求欄位資訊，如果引數是一個物件，則需要在物件欄位上添加註解

public class UserQueryCondition
 
 {
    @ApiModelProperty(value = "使用者名稱")
    private String username;

不是物件的欄位描述

@JsonView(User.UserDetailView.class)
public User getInfo(@ApiParam(value = "使用者id") @PathVariable String id) {

上面是3個常用的註解，其他的官網文件檢視；

個人感覺：相對於spring-restdocs-asciidoctor程式碼入侵太嚴重，我個人是不太願意用的；但是的確很方便能看到所有提供的服務；包括spring框架提供的

下一節：使用WireMock快速偽造restful服務