Swagger注解及參數細節的正確書寫。


今天新開了一個api文件,結果怎么搞也在swagger里顯示不出來,浪費半天后,去問老員工了。

一般有倆原因,

1.idea緩存,重啟idea即可。

2.注解和參數上的修飾有問題,或者請求method不對。

下面說一下在書寫上幾個需要注意的點。

1.對於無參方法(一般是后端調用的inner方法),一般不會出錯。

2.首先區分get請求還是post請求

 

 

入參是dto對象的都用post請求,即@PostMapping,這樣才能解析json格式數據。在參數前面加上 @RequestBody注解,注意dataType要寫對應的dto類型,name要與參數名一致。

還要加上這個值 paramType = "body"。  

 

 注意在controller層中也要加,@RequestParam 不用在controller中加了。

3.對於list<>列表型入參,也需要用 @RequestBody注解修飾,dataType一般是String

 

 4.對於get請求,@GetMapping,一般是單個入參,

 

 在參數前面加@RequestParam(),其實get請求加@RequestBody還是@RequestParam()都行。

5.最后要在controller和service層impl里加上對應的注解

@RestController和  @Service


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM