ApiOperation和ApiParam注解依賴的安裝和使用以及注意事項說明
ApiOperation和ApiParam注解依賴的安裝
如果要使用@ApiOperation注解，需要引入swagger，而不是引入OpenAPI
引入依賴
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>啟動類設(shè)置注解啟動
這樣就可以在controller里使用 @ApiOperation 注解了，通過瀏覽器訪問 http://localhost:8088/swagger-ui.html
ApiOperation和ApiParam注解的使用
常用的有
@Api@ApiOperation@ApiParam
Api
ApiOperation和ApiParam
@ApOperation 不是spring自帶的注解是swagger里面的 com.wordnik.swagger.annotations.ApiOperation;
詳細介紹： @ApiOperation 和 @ApiParam 為添加的Controller接口相關(guān)注解，個參數(shù)說明如下：
@ApiOperation( value = “接口說明”, httpMethod = “接口請求方式”, response = “接口返回參數(shù)類型”, notes = “接口發(fā)布說明”；
其他參數(shù)可參考源碼；
@ApiParam( required = “是否必須參數(shù)”, name = “參數(shù)名稱”, value = “參數(shù)具體描述”
其中部分參數(shù)可以根據(jù)需求增加或者刪除
@ApiParam 的使用方式和@RequestParam 有點像, 并且可以像如下這樣使用
public DataResult<ZonesEiaPlanPageInfoVO> detail(@RequestParam @ApiParam(name = "id", value = "主鍵") String id) {}拓展
實際項目中非常需要寫文檔，提高Java服務(wù)端和Web前端以及移動端的對接效率。
由于我們在開發(fā)中接口眾多而且細節(jié)復(fù)雜（需要考慮不同的HTTP請求類型，HTTP頭部信息，HTTP請求內(nèi)容等）高質(zhì)量地創(chuàng)建這份文檔本身就是一件復(fù)雜的事情。
隨著時間的前進和技術(shù)的推移，不斷修改接口實現(xiàn)的時候都必須同步修改接口文檔，而接口文檔和代碼又處于不同時空的兩個地方。
注意事項
如果說打不開那個swagger網(wǎng)頁
- 檢查是否使用了@EnableSwagger2
- 是否有自定義了api前綴
- 是否有攔截器攔截
總結(jié)
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了idea工具欄如何添加快捷圖標的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-02-02
SpringBoot中如何統(tǒng)一接口返回與全局異常處理詳解
全局異常處理是個比較重要的功能,一般在項目里都會用到,這篇文章主要給大家介紹了關(guān)于SpringBoot中如何統(tǒng)一接口返回與全局異常處理的相關(guān)資料,文中通過示例代碼介紹的非常詳細,需要的朋友可以參考下2021-09-09
這篇文章主要介紹了java中的transient關(guān)鍵字解讀,transient關(guān)鍵字的主要作用就是讓某些被transient關(guān)鍵字修飾的成員屬性變量不被序列化,實際上也正是因此,在學(xué)習過程中很少用得上序列化操作,一般都是在實際開發(fā)中,需要的朋友可以參考下2023-09-09
maven目前在web上面的使用方式很普遍，而打包的方式也存在很多方式，本文就詳細的介紹了三種方式，具有一定的參考價值，感興趣的可以了解下2021-06-06
這篇文章主要介紹了Java的Struts框架中配置國際化的資源存儲的要點解析,針對用戶所使用的語言來配置資源文件,需要的朋友可以參考下2016-04-04
SpringBoot+Redis執(zhí)行l(wèi)ua腳本的5種方式總結(jié)
Lua是一種快速、輕量級的腳本語言,廣泛應(yīng)用于各種領(lǐng)域,包括數(shù)據(jù)庫,Redis作為一個內(nèi)嵌Lua解釋器的NoSQL數(shù)據(jù)庫,允許通過Lua腳本在服務(wù)器端執(zhí)行一些復(fù)雜的操作,本文給大家介紹了使用SpringBoot Redis執(zhí)行l(wèi)ua腳本的五種方式,需要的朋友可以參考下2023-11-11
Spring中BeanFactory?FactoryBean和ObjectFactory的三種的區(qū)別
關(guān)于FactoryBean?和?BeanFactory的對比文章比較多，但是對ObjectFactory的描述就比較少，今天我們對比下這三種的區(qū)別，感興趣的朋友跟隨小編一起看看吧2023-01-01
Springboot+AOP實現(xiàn)時間參數(shù)格式轉(zhuǎn)換
前端傳過來的時間參數(shù)，后端可以自定義時間格式轉(zhuǎn)化使用，這樣想轉(zhuǎn)成什么就轉(zhuǎn)成什么。本文將利用自定義注解AOP實現(xiàn)時間參數(shù)格式轉(zhuǎn)換，感興趣的可以了解一下2022-04-04
jsoup是一款基于Java的HTML解析器,它提供了一套非常省力的API,不但能直接解析某個URL地址、HTML文本內(nèi)容,而且還能通過類似于DOM、CSS或者jQuery的方法來操作數(shù)據(jù),所以?jsoup?也可以被當做爬蟲工具使用,這篇文章主要介紹了什么是jsoup及jsoup的使用,需要的朋友可以參考下2023-10-10
Java集合之Set、HashSet、LinkedHashSet和TreeSet深度解析
這篇文章主要介紹了Java集合之Set、HashSet、LinkedHashSet和TreeSet深度解析,List是有序集合的根接口,Set是無序集合的根接口,無序也就意味著元素不重復(fù),更嚴格地說,Set集合不包含一對元素e1和e2 ,使得e1.equals(e2) ,并且最多一個空元素,需要的朋友可以參考下2023-09-09