swagger2的介面文件

以前見過乙個swagger2的介面文件，特別好用，好看，對介面中入參描述的很詳細；適合用於專案的開發

後來自己做專案的時候，沒有找到這個swagger版本

io.springfox

springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2

備註：@api: 描述類/介面的主要用途

@apioperation: 描述方法用途

@apiimplicitparam: 描述方法的引數

@apiimplicitparams: 描述方法的引數(multi-params)

@apiparam:請求屬性

@apiignore: 忽略某類/方法/引數的文件

@apiresponses：響應集配置

@responseheader: 響應頭設定

@apimodelproperty:新增和操作模型屬性的資料

io.springfox

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

高版本ui展示變了，高版本能顯示實體類中的物件屬性

不是之前我看到的，還是要繼續尋找更好的api介面文件展示方式。。。。

專案測試的**

@enableswagger2 //通過@enableswagger2註解啟用swagger2

public class swagger2

private apiinfo apiinfo()

}

package com.example.demo.entity;

import io.swagger.annotations.apimodel;
import io.swagger.annotations.apimodelproperty;
@apimodel
public class user 
}

package com.example.demo.controller;

import com.example.demo.entity.user;
import io.swagger.annotations.api;
import io.swagger.annotations.apiimplicitparam;
import io.swagger.annotations.apiimplicitparams;
import io.swagger.annotations.apioperation;
import org.springframework.web.bind.annotation.*;
@restcontroller
@api(tags = "使用者管理相關介面")
public class usercontroller 
)public user adduser(string username, @requestparam(required = true) string address) 
@apioperation("根據id查詢使用者的介面")
@apiimplicitparam(name = "id", value = "使用者id", defaultvalue = "1", required = true)
public user getuserbyid(@pathvariable integer id) 
@apioperation("根據id更新使用者的介面")
public user updateuserbyid(@requestbody user user) 
}

swagger2 生成介面文件步驟

匯入jar包 swagger2 io.springfox groupid springfox swagger2 artifactid dependency 防止進入swagger頁面報型別轉換錯誤，排除2.9 2中的引用，手動增加1.5 21版本 io.swagger groupid swagger...

工具 Swagger2寫介面注釋

作為一名coder，經常需要向別人提供介面，或者呼叫別人的介面。於是就有了介面引數是什麼意思，要怎麼傳引數，返回值是什麼意思 有多少呼叫方，就會有多少人來詢問這些引數。如果是長時間之後，自己或許都不知道這些引數是什麼意思。於是維護介面文件便成了一項必不可少的工作，維護文件也有很多問題 swagger...

整合Swagger2文件api

路徑 http localhost 8088 doc.html 原路徑 apiignore 介面展示忽略 api value 註冊登入 tags 使用者名稱是否存在 notes 使用者名稱是否存在 使用者物件bo description 從客戶端，由使用者傳入的資料封裝在此entity中 apimo...