生產力介面文件工具 Swagger

2021-09-27 02:52:48 字數 2110 閱讀 6337

使用示例

注意事項

生產環境禁用swagger

bug常用註解

@api 描述類/介面的主要用途

@apioperation 描述方法用途

@apiimplicitparam 描述方法的引數

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

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

@api(tags = "protocolapicontroller" ,description = "協議 管理")

public class protocolapicontroller

@apioperation 描述方法用途

@apioperation(value = "查詢單個 協議",notes = "備註,可以寫很多東西")
@apiimplicitparam 描述引數

paramtype   引數型別,直接寫字串即可

path 路徑佔位引數

form 表單提交,即formdata

query 查詢引數

body json格式提交的請求體引數

datatype 資料型別,直接寫字串即可

int 數值

string 字串

user 物件

list集合

示例1:

@apiimplicitparams()

@login

@apioperation("修改 協議")

public r update(@pathvariable long id ,@apiignore protocolentity protocol)

protocolservice.updatebyid(protocol);

return r.ok();

}

示例2:

@apioperation("更新使用者")

@apiimplicitparam(name = "user", value = "單個使用者資訊", datatype = "user")

public boolean update(user user)

@apioperation("批量刪除")

@apiimplicitparam(name = "users", value = "n個使用者資訊", datatype = "list")

public boolean delete(@requestbody listusers)

示例3:

/**

* 修改訂單狀態

*/@apiimplicitparams()

@login

@apioperation("修改訂單狀態")

public apiresponse userchangephone(long id,integer status)

示例4:

/**

* 資訊

*/@apiimplicitparam(name = "taskitemuserid", value = "訂單id", required = true, paramtype = "query", datatype = "long")

@apioperation("查詢單個訂單的曬圖")

public apiresponseinfo(@requestparam("taskitemuserid") long taskitemuserid)

優點:

缺點:

swaggerconfig類上新增註解,表明生效的環境即可

@profile("dev")

參考:

如果多個物件的@apimodel名字重複,會導致文件顯示錯亂

生產力工具 Mysql入門

型別 說明char 固定字串長度 varchar 可變長度字串 text 大文字enum 列舉型別 只能取乙個元素 set集合型別 能取多個元素 約束條件 說明primary key 表示該屬性為該錶的主鍵,可以唯一的標識對應的記錄 foreign key 標識該屬性為該錶的外來鍵,與某錶的主鍵關聯...

生產力工具 github入門指南

題記 github只是乙個工具,怎麼利用好它是自己的事。這兩天看了許多關於使用github的文章,本來想自己寫一篇總結的但是鑑於自己文筆捉急 水平有限,所以在此將我認為比較好的文章進行歸納總結,以便自己以後查閱。1.github入門 1 知乎文科妹子教你用github 2 github deskto...

將Ubuntu配置為生產力工具

本人最近開始使用ubuntu作為開發主力編寫 經過一段時間的嘗試,發現ubuntu基本能夠滿足生產力機器的需求。下面講本人的配置 軟體分享給大家 使用的作業系統為ubuntu 18.04 lts 中文版。使用中文版的原因是,將來寫漢字比較方便。安裝的時候按預設配置一路安裝即可。瀏覽器 系統自帶的fi...