1. @Api

用于修飾類，在qs項目中用于描述Controller

參數(shù)：description 用于對該類的定義或描述該類的作用

@Api(description = "備忘錄相關(guān)接口") @RestController public class MemoController {private final MemoRepository memoRepository; @Autowired public MemoController(MemoRepository memoRepository) {this.memoRepository = memoRepository; }

2. @ApiOperation

用于修飾方法或接口

參數(shù)：value = " ?", 對方法的簡述

? ? note = " ?", 對方法或接口的具體描述

/** * 查詢 * * @return */ @ApiOperation(value="根據(jù)用戶id獲取備忘錄列表", notes="獲取當(dāng)前用戶的所有備忘錄") @RequestMapping(value = "/{userId}/memos", method = RequestMethod.GET) public ResultData list(@ApiParam(required = true, value = "用戶id") @PathVariable("userId") String userId) {List<Memo> memos = memoRepository.findByUserId(userId); return ResultData.ok().putDataValue("memos", memos); } 3. @ApiParam

用于對每個參數(shù)的描述

參數(shù)：required = true, ?表示該參數(shù)是必要參數(shù)。

? ? value, 對參數(shù)的描述

注：Swagger對所有參數(shù)是可選的(required可以是false),

但是當(dāng)參數(shù)作為路徑參數(shù)總是必須的，也就是說當(dāng)參數(shù)出現(xiàn)在路徑中時，required必須為true。

如下圖代碼中的userId.

/** * 按照memoId查找 * * @param id * @return */ @ApiOperation(value="根據(jù)備忘錄id獲取備忘錄信息", notes="獲取當(dāng)前備忘錄信息") @RequestMapping(value = "/{userId}/memos/{id}", method = RequestMethod.GET) public ResultData find(@ApiParam(required = true, value = "用戶id") @PathVariable("userId") String userId, @ApiParam(required = true, value = "備忘錄id") @PathVariable("id") String id) {Memo memo = memoRepository.findOne(id); return ResultData.ok().putDataValue("memo", memo); }

其他注解可參考http://www.cnblogs.com/java-zhao/p/5348113.html

總結(jié)

以上是生活随笔為你收集整理的Swagger的三个常用注解的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。