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;
詳細(xì)介紹： @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ā)中接口眾多而且細(xì)節(jié)復(fù)雜（需要考慮不同的HTTP請求類型，HTTP頭部信息，HTTP請求內(nèi)容等）高質(zhì)量地創(chuàng)建這份文檔本身就是一件復(fù)雜的事情。
隨著時間的前進(jìn)和技術(shù)的推移，不斷修改接口實現(xiàn)的時候都必須同步修改接口文檔，而接口文檔和代碼又處于不同時空的兩個地方。
注意事項
如果說打不開那個swagger網(wǎng)頁
- 檢查是否使用了@EnableSwagger2
- 是否有自定義了api前綴
- 是否有攔截器攔截
總結(jié)
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了java中ResultSet遍歷數(shù)據(jù)操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-08-08
使用Java Stream將集合轉(zhuǎn)換為一對一Map的方法詳解
在日常的開發(fā)工作中,我們經(jīng)常使用到Java Stream,特別是Stream API中提供的Collectors.toList()收集器,但有些場景下,我們需要將集合轉(zhuǎn)換為Map,所以本文就給大家介紹了如何使用Java Stream將集合轉(zhuǎn)換為一對一Map,需要的朋友可以參考下2025-12-12
Spring Boot項目@RestController使用重定向redirect方式
這篇文章主要介紹了Spring Boot項目@RestController使用重定向redirect方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
Spring?MVC和springboot靜態(tài)資源處理問題
這篇文章主要介紹了Spring?MVC和springboot靜態(tài)資源處理問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-08-08
springMVC向Controller傳值出現(xiàn)中文亂碼的解決方案
這篇文章主要介紹了springMVC向Controller傳值出現(xiàn)中文亂碼的解決方案，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-02-02
關(guān)于Jmeter接口測試實戰(zhàn)-Cookies
這篇文章主要介紹了關(guān)于Jmeter接口測試實戰(zhàn)-Cookies問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-03-03
SpringCloud?分布式微服務(wù)架構(gòu)操作步驟
SpringCloud是一種微服務(wù)的框架，利用它我們可以去做分布式服務(wù)開發(fā)，這篇文章主要介紹了SpringCloud?分布式微服務(wù)架構(gòu),需要的朋友可以參考下2022-07-07
這篇文章主要介紹了Spring Boot 2.X 快速集成單元測試解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-08-08
Spring Boot 中的 Spring Cloud Feign的原
Spring Cloud Feign 是 Spring Cloud 中的一個組件，它可以幫助我們實現(xiàn)聲明式的 REST 客戶，這篇文章主要介紹了Spring Boot 中的 Spring Cloud Feign,需要的朋友可以參考下2023-07-07
這篇文章主要為大家詳細(xì)介紹了Java截取中英文混合字符串的方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-06-06