ddingdong-be/src/main/java/ddingdong/ddingdongBE/domain/feed/api/ClubFeedApi.java at 6b237863274ca523903dfc6849d4a09abe49bd7c · COW-dev/ddingdong-be · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
package ddingdong.ddingdongBE.domain.feed.api;

import ddingdong.ddingdongBE.auth.PrincipalDetails;
import ddingdong.ddingdongBE.domain.feed.controller.dto.request.CreateFeedRequest;
import ddingdong.ddingdongBE.domain.feed.controller.dto.request.UpdateFeedRequest;
import ddingdong.ddingdongBE.domain.feed.controller.dto.response.ClubMonthlyStatusResponse;
import ddingdong.ddingdongBE.domain.feed.controller.dto.response.MyFeedPageResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;
import org.springframework.http.HttpStatus;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;

@Tag(name = "Feed - Club", description = "Feed API")
@RequestMapping("/server/central")
public interface ClubFeedApi {

    @Operation(summary = "동아리 피드 생성 API")
    @ApiResponse(responseCode = "201", description = "동아리 피드 생성 성공")
    @ResponseStatus(HttpStatus.CREATED)
    @SecurityRequirement(name = "AccessToken")
    @PostMapping("/my/feeds")
    void createFeed(
        @RequestBody @Valid CreateFeedRequest createFeedRequest,
        @AuthenticationPrincipal PrincipalDetails principalDetails
    );

    @Operation(summary = "동아리 피드 수정 API")
    @ApiResponse(responseCode = "204", description = "동아리 피드 수정 성공")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    @SecurityRequirement(name = "AccessToken")
    @PutMapping("/my/feeds/{feedId}")
    void updateFeed(
        @PathVariable("feedId") Long feedId,
        @RequestBody @Valid UpdateFeedRequest updateFeedRequest
    );

    @Operation(summary = "동아리 피드 삭제 API")
    @ApiResponse(responseCode = "204", description = "동아리 피드 삭제 성공")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    @SecurityRequirement(name = "AccessToken")
    @DeleteMapping("/my/feeds/{feedId}")
    void deleteFeed(
        @PathVariable("feedId") Long feedId
    );

    @Operation(summary = "중앙 동아리 피드 목록 조회 API")
    @ApiResponse(responseCode = "200", description = "중앙 동아리 피드 목록 조회 성공",
        content = @Content(schema = @Schema(implementation = MyFeedPageResponse.class)))
    @ResponseStatus(HttpStatus.OK)
    @SecurityRequirement(name = "AccessToken")
    @GetMapping("/my/feeds")
    MyFeedPageResponse getMyFeedPage(
        @AuthenticationPrincipal PrincipalDetails principalDetails,
        @RequestParam(value = "size", defaultValue = "9") int size,
        @RequestParam(value = "currentCursorId", defaultValue = "-1") Long currentCursorId
    );

    @Operation(summary = "동아리 이달의 현황 조회 API")
    @ApiResponse(responseCode = "200", description = "동아리 이달의 현황 조회 성공",
        content = @Content(schema = @Schema(implementation = ClubMonthlyStatusResponse.class)))
    @ResponseStatus(HttpStatus.OK)
    @SecurityRequirement(name = "AccessToken")
    @GetMapping("/feeds/status")
    ClubMonthlyStatusResponse getFeedStatus(
        @AuthenticationPrincipal PrincipalDetails principalDetails,
        @RequestParam("year") @Min(value = 2000, message = "year는 2000 이상이어야 합니다.") @Max(value = 2100, message = "year는 2100 이하여야 합니다.") int year,
        @RequestParam("month") @Min(value = 1, message = "month는 1 이상이어야 합니다.") @Max(value = 12, message = "month는 12 이하여야 합니다.") int month
    );
}