用于 api 类、方法、参数、返回值说明!
代码:
@RestController
@Api(tags = "文章模块") // 作用与类上,描述类
public class ArticleController {
@PostMapping("/addArticle")
@ApiOperation("新增一篇文章") // 作用于方法上,描述方法
@ApiImplicitParam(name = "article",value = "新增的文章对象") // 作用于方法上,描述单个参数
public Boolean addArticle( Article article) {
return false;
}
// 首页初始化 数据获取
@GetMapping("/init")
@ApiOperation("首页初始化数据获取")
@ApiImplicitParams({@ApiImplicitParam(name = "pageIndex",value = "当前页"),@ApiImplicitParam(name = "pageSize",value = "页面大小")}) // 作用于方法上,描述多个参数
@ApiResponses({
@ApiResponse(code = 200,message = "新增成功"),
@ApiResponse(code = 400,message = "请求参数不匹配"),
@ApiResponse(code = 500,message = "服务器异常")
}) // 作用于方法上,描述返回值
public ResponseData init(int pageIndex,int pageSize) {
return ResponseData.ok();
}
// 文章显示页面
@GetMapping("/getArticleInfo/{id}")
@ApiOperation("根据ID获取单篇文章")
@ApiImplicitParam(name = "id",value = "文章的ID")
public ResponseData toArticlePage(@PathVariable("id") int id){
return ResponseData.ok();
}
// 获取技术分享页面数据
@GetMapping("/learnShare")
@ApiOperation("技术分享页数据获取")
@ApiImplicitParams({@ApiImplicitParam(name = "pageIndex",value = "当前页"),@ApiImplicitParam(name = "pageSize",value = "页面大小")})
public ResponseData learnShare(int pageIndex,int pageSize){
return ResponseData.ok();
}
// 获取程序人生页面数据
@GetMapping("/lifeDribs")
@ApiOperation("程序人生页数据获取")
@ApiImplicitParams({@ApiImplicitParam(name = "pageIndex",value = "当前页"),@ApiImplicitParam(name = "pageSize",value = "页面大小")})
public ResponseData lifeDribs(int pageIndex,int pageSize){
return ResponseData.ok();
}
@GetMapping("/addLove/{id}")
@ApiOperation("文章点赞次数+1")
@ApiImplicitParam(name = "id",value = "被点赞的文章ID")
public boolean addLove(@PathVariable("id") int id){
return false;
}
}
(m 。 m)....