swagger文档完善

This commit is contained in:
linfeng 2023-07-18 10:42:27 +08:00
parent 20556f1bcc
commit 163e264a8a
2 changed files with 22 additions and 10 deletions

View File

@ -26,6 +26,7 @@ import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;
/**
*
@ -52,7 +53,8 @@ public class AppCommentController {
@ApiImplicitParam(name = "postId", value = "帖子id", paramType = "query",dataType = "Integer", required = true),
@ApiImplicitParam(name = "page", value = "分页页码",paramType = "query", dataType = "Integer", required = true)
})
public R list(@RequestParam("postId")Integer postId,@RequestParam("page")Integer page){
public R list(@RequestParam("postId")Integer postId,
@RequestParam("page")Integer page){
AppPageUtils pages =commentService.queryCommentPage(postId,page);
return R.ok().put("result", pages);
@ -65,7 +67,8 @@ public class AppCommentController {
@Login
@PostMapping("/thumbs")
@ApiOperation("评论区的点赞")
public R thumbs(@RequestBody AddThumbsForm request, @LoginUser AppUserEntity user){
public R thumbs(@RequestBody AddThumbsForm request,
@ApiIgnore @LoginUser AppUserEntity user){
commentThumbsService.addThumbs(request,user);
return R.ok();
@ -77,7 +80,8 @@ public class AppCommentController {
@Login
@PostMapping("/cancelThumbs")
@ApiOperation("取消评论区的点赞")
public R cancelThumbs(@RequestBody AddThumbsForm request,@LoginUser AppUserEntity user){
public R cancelThumbs(@RequestBody AddThumbsForm request,
@ApiIgnore @LoginUser AppUserEntity user){
commentThumbsService.cancelThumbs(request,user);
return R.ok();

View File

@ -31,6 +31,7 @@ import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;
/**
* @author linfeng
@ -66,7 +67,8 @@ public class AppPostController {
@ApiImplicitParams({
@ApiImplicitParam(name = "page", value = "分页",paramType = "query", dataType = "Integer", required = true)
})
public R followUserPost(@RequestParam Integer page, @LoginUser AppUserEntity user){
public R followUserPost(@RequestParam Integer page,
@ApiIgnore @LoginUser AppUserEntity user){
AppPageUtils pages =postService.followUserPost(page,user);
if(ObjectUtil.isNull(pages)){
@ -83,7 +85,8 @@ public class AppPostController {
@Login
@PostMapping("/addCollection")
@ApiOperation("帖子点赞收藏")
public R addCollection(@RequestBody AddCollectionForm request, @LoginUser AppUserEntity user){
public R addCollection(@RequestBody AddCollectionForm request,
@ApiIgnore @LoginUser AppUserEntity user){
postService.addCollection(request,user);
return R.ok();
@ -95,7 +98,8 @@ public class AppPostController {
@Login
@PostMapping("/cancelCollection")
@ApiOperation("帖子取消点赞收藏")
public R cancelCollection(@RequestBody AddCollectionForm request, @LoginUser AppUserEntity user){
public R cancelCollection(@RequestBody AddCollectionForm request,
@ApiIgnore @LoginUser AppUserEntity user){
postCollectionService.cancelCollection(request,user);
return R.ok();
}
@ -106,7 +110,8 @@ public class AppPostController {
@ApiImplicitParams({
@ApiImplicitParam(name = "page", value = "分页",paramType = "query", dataType = "Integer", required = true)
})
public R myPost(@RequestParam("page") Integer page, @LoginUser AppUserEntity user){
public R myPost(@RequestParam("page") Integer page,
@ApiIgnore @LoginUser AppUserEntity user){
AppPageUtils pages =postService.myPost(page,user);
return R.ok().put("result", pages);
@ -119,7 +124,8 @@ public class AppPostController {
@ApiImplicitParams({
@ApiImplicitParam(name = "page", value = "分页",paramType = "query", dataType = "Integer", required = true)
})
public R myCollectPost(@RequestParam("page") Integer page, @LoginUser AppUserEntity user){
public R myCollectPost(@RequestParam("page") Integer page,
@ApiIgnore @LoginUser AppUserEntity user){
AppPageUtils pages =postService.myCollectPost(page,user);
return R.ok().put("result", pages);
@ -151,7 +157,8 @@ public class AppPostController {
@Login
@PostMapping("/addPost")
@ApiOperation("发帖子")
public R addPost(@RequestBody AddPostForm request, @LoginUser AppUserEntity user){
public R addPost(@RequestBody AddPostForm request,
@ApiIgnore @LoginUser AppUserEntity user){
ValidatorUtils.validateEntity(request);
Integer id=postService.addPost(request,user);
if(id==0){
@ -163,7 +170,8 @@ public class AppPostController {
@Login
@PostMapping("/list")
@ApiOperation("帖子列表分页")
public R list(@RequestBody PostListForm request, @LoginUser AppUserEntity user){
public R list(@RequestBody PostListForm request,
@ApiIgnore @LoginUser AppUserEntity user){
AppPageUtils page = postService.queryPageList(request,user);