swagger2隱藏在API文件顯示某些引數

2021-10-01 20:36:52 字數 484 閱讀 9907

有時候,利用swagger2建立api文件時,有些引數是需要隱藏在api文件顯示,在方法中,引數的名字前加上

@apiignore  就可以了:
@apiresponses()

@apioperation(value = "修改商家證照資料", notes = "修改商家證照資料", response = merchantexten***o.class)

@apiimplicitparams()

public resultdata modicertificate(@multirequestbody @apiignore merchantexten***o merchantexten***o,

@multirequestbody @apiignore merchantprovepicvdo merchantprovepicvdo,

@multirequestbody @apiignore listmerchantothervdolist)

整合Swagger2文件api

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

05 配置Swagger2生成API介面文件

前後端分離開發模式中,api文件是最好的溝通方式。swagger 是乙個規範和完整的框架,用於生成 描述 呼叫和視覺化 restful 風格的 web 服務。及時性 介面變更後,能夠及時準確地通知相關前後端開發人員 規範性 並且保證介面的規範性,如介面的位址,請求方式,引數及響應格式和錯誤資訊 一致...

springboot搭建swagger2超簡單

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