前後端分離開發模式中，api文件是最好的溝通方式。
swagger 是乙個規範和完整的框架，用於生成、描述、呼叫和視覺化 restful 風格的 web 服務。
1.及時性 (介面變更後，能夠及時準確地通知相關前後端開發人員)
2.規範性 (並且保證介面的規範性，如介面的位址，請求方式，引數及響應格式和錯誤資訊)
3.一致性 (介面資訊一致，不會出現因開發人員拿到的文件版本不一致，而出現分歧)
4.可測性 (直接在介面文件上進行測試，以方便理解業務)
<
!--swagger--
>
io.springfox<
/groupid>
springfox-swagger2<
/artifactid>
2.9.2
<
/version>
<
/dependency>
io.springfox<
/groupid>
springfox-swagger-ui<
/artifactid>
2.9.2
<
/version>
<
/dependency>
@configuration
@enableswagger2
public
class
swaggerconfig
private apiinfo webapiinfo()
}
定義在類上：@api
定義在方法上：@apioperation
定義在引數上：@apiparam
訪問路徑path+/swagger-ui.html
Swagger筆記 Swagger3配置
swagger是一組圍繞openapi規範構建的開源工具，可幫助您設計 構建 記錄和使用rest api。主要的swagger工具包括 swagger editor 基於瀏覽器的編輯器，您可以在其中編寫openapi規範。swagger ui 將openapi規範呈現為互動式api文件。swagge...
Swagger基礎總結
the best apis are built with swagger tools swagger分為四部分 1.openapi規範的版本號 通過乙個 swagger 屬性來宣告openapi規範的版本。swagger 2.0 2.api描述資訊 文件相關資訊 info version 1.0.0...
Swagger基礎學習
api框架 restful文件自動生成工具，api文件與定義的同步更新 使用兩個庫 io.springfoxgroupid springfox swagger uiartifactid 2.10.5version dependency io.springfoxgroupid springfox sw...