工具 Swagger2寫介面注釋

2022-07-09 17:12:11 字數 1425 閱讀 9340

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

swagger(官方文件)可以快速幫助實現介面api的維護與簡單測試。

@apiimplicitparam(name = "userid",value = "使用者id",datatype = "int",paramtype = "path")
@apiimplicitparams()
@apimodel(value = "user", description = "user物件")

public class usermodel

這樣就可以通過訪問 http://localhost:8080/swagger-ui.html 看到介面api呼叫說明。dem

swagger2的介面文件

以前見過乙個swagger2的介面文件,特別好用,好看,對介面中入參描述的很詳細 適合用於專案的開發 後來自己做專案的時候,沒有找到這個swagger版本 io.springfox springfox swagger2 2.9.2 io.springfox springfox swagger ui ...

springboot搭建swagger2超簡單

必須使用以下配置開啟swagger服務 enableswagger2 configuration enableswagger2 public class swaggerconfig implements webmvcconfigurer private apiinfo apiinfo api tag...

Swagger2使用記錄

configuration public class swagger2 private apiinfo apiinfo enableswagger2 public static void main string args io.springfox springfox swagger2 2.9.2 i...