Swagger 注解~用于方法
生活随笔
收集整理的這篇文章主要介紹了
Swagger 注解~用于方法
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
@ApiOperation?用于方法;表示一個http請求的操作
value用于方法描述
notes用于提示內容
tags可以重新分組(視情況而用)
@ApiParam?用于參數,字段說明;表示對參數的添加元數據(說明或是否必填等)
name–參數名
value–參數說明
required–是否必填
?
@Api(value="用戶controller",tags={"用戶操作接口"}) @RestController public class UserController {@ApiOperation(value="獲取用戶信息",tags={"獲取用戶信息copy"},notes="注意問題點")@GetMapping("/getUserInfo")public User getUserInfo(@ApiParam(name="id",value="用戶id",required=true) Long id,@ApiParam(name="username",value="用戶名") String username) {// userService可忽略,是業務邏輯User user = userService.getUserInfo();return user;} }效果圖:
總結
以上是生活随笔為你收集整理的Swagger 注解~用于方法的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 掌控谈话~重复对方的话
- 下一篇: Redis系列六、redis的五种数据结