SpringBoot中swagger的使用
swagger組件有swagger editor 基于瀏覽器編輯器,swagger ui 可視化ui展示描述文件 ,swagger inspector 和ui組件很像,可以返回更多信息,會保存請求實際參數,spring fox 是可以根據代碼生成接口文檔,所以描述文件是根據項目來變化的,不用手動更新,springboot導入spring-fox依賴就是導入了wagger,在啟動類上添加@EnableSwagger2注解,添加這個注解后表示啟動項目就會啟動swagger組件,對當前項目全部控制器進行掃描,訪問swagger-ui啟動項目后在瀏覽器中輸入 http://ip:port/swagger-ui.html在swagger-ui中可視化操作項目接口,
swagger配置可以在項目中創建SwaggerConfig 配置對象來進行配置文檔內容Docket對象 通過這個對象配置描述文件信息通過apis()方法來設置哪些包中的內容被掃描,
常用注解@Api是類上注解 控制了整個類生成接口信息的內容,屬性tags 類的名字 description描述@ApiOperation 寫在方法上的注解,對方法進行描述, 屬性value 方法描述 notes 提示信息@ApiParam 寫在方法參數中的注解,用于對參數進行描述,說明一下是否是必填項,屬性有 name 參數名字 value參數描述 required是否是必須@ApiModel是類上注解,主要應用在實體類上,屬性value 類名稱,description 是描述@ApiModelproperty可以應用在方法上或是屬性上,用于方法參數是應用類型時進行定義描述@Apilgnore 用于類上方法上參數上,表示被忽視,
前后端分離一般使用vue+springboot后端:后端控制層 服務層 數據訪問層前端:前端控制層 視圖層前后端交互 API創建springboot項目 導入對應的依賴
啟動swagger界面查看
配置swaggerswagger有自己的配置實例對象 Docket這個對象方法中有多個屬性apiinfo屬性是配置swagger顯示的信息select()配置掃描接口groupname()配置api文檔的分組 配置多個Docket實例可以實現多個分組,多個@bean
到此這篇關于SpringBoot中swagger的使用的文章就介紹到這了,更多相關swagger的使用內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網!
相關文章:
