[FEAT] Notice/EventNotice 관련 API 개발

src/docs/asciidoc/eventNotice.adoc

@@ -0,0 +1,32 @@
+== 이벤트 공지 사항 API
+:source-highlighter: highlightjs
+
+=== 이벤트 공지 사항 생성 (POST /eventNotices)
+
+====
+operation::event-notice-controller-test/create-event-notice[snippets="http-request,request-fields,http-response,response-fields"]
+====
+
+=== 이벤트 공지 사항 리스트 조회 (GET /eventNotices)
+
+====
+operation::event-notice-controller-test/get-event-notice-list[snippets="query-parameters,http-request,http-response,response-fields"]
+====
+
+=== 이벤트 공지 사항 조회 (GET /eventNotices/{eventNoticeId})
+
+====
+operation::event-notice-controller-test/get-event-notice[snippets="path-parameters,http-request,http-response,response-fields"]
+====
+
+=== 이벤트 공지 사항 수정 (PUT /eventNotices/{eventNoticeId})
+
+====
+operation::event-notice-controller-test/update-event-notice[snippets="path-parameters,http-request,request-fields,http-response,response-fields"]
+====
+
+=== 이벤트 공지 사항 삭제 (DELETE /eventNotices/{eventNoticeId})
+
+====
+operation::event-notice-controller-test/delete-event-notice[snippets="path-parameters,http-request,http-response"]
+====

src/docs/asciidoc/index.adoc

@@ -7,6 +7,6 @@
 
 include::jobInterview.adoc[]
 include::talk.adoc[]
-include::auth-controller-test.adoc[]
-// include::eventPeriod.adoc[] 컨트롤러별로 주석 지우고 문서 추가
-
+include::notice.adoc[]
+include::eventNotice.adoc[]
+include::auth-controller-test.adoc[]

src/docs/asciidoc/notice.adoc

@@ -0,0 +1,32 @@
+== 공지 사항 API
+:source-highlighter: highlightjs
+
+=== 공지 사항 생성 (POST /notices)
+
+====
+operation::notice-controller-test/create-notice[snippets="http-request,request-fields,http-response,response-fields"]
+====
+
+=== 공지 사항 리스트 조회 (GET /notices)
+
+====
+operation::notice-controller-test/get-notice-list[snippets="query-parameters,http-request,http-response,response-fields"]
+====
+
+=== 공지 사항 조회 (GET /notices/{noticeId})
+
+====
+operation::notice-controller-test/get-notice[snippets="path-parameters,http-request,http-response,response-fields"]
+====
+
+=== 공지 사항 수정 (PUT /notices/{noticeId})
+
+====
+operation::notice-controller-test/update-notice[snippets="path-parameters,http-request,request-fields,http-response,response-fields"]
+====
+
+=== 공지 사항 삭제 (DELETE /notices/{noticeId})
+
+====
+operation::notice-controller-test/delete-notice[snippets="path-parameters,http-request,http-response"]
+====

src/main/java/com/scg/stop/StopApplication.java

@@ -2,13 +2,12 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
 
 @SpringBootApplication
 public class StopApplication {
 
-	public static void main(String[] args) {
-		SpringApplication.run(StopApplication.class, args);
-	}
+    public static void main(String[] args) {
+        SpringApplication.run(StopApplication.class, args);
+    }
 
-}
+}

src/main/java/com/scg/stop/domain/file/domain/File.java

@@ -1,22 +1,17 @@
 package com.scg.stop.domain.file.domain;
 
-import static jakarta.persistence.FetchType.LAZY;
-import static jakarta.persistence.GenerationType.IDENTITY;
-import static lombok.AccessLevel.PROTECTED;
-
-import com.scg.stop.domain.event.domain.EventNotice;
 import com.scg.stop.domain.gallery.domain.Gallery;
-import com.scg.stop.domain.notice.domain.Notice;
+import com.scg.stop.event.domain.EventNotice;
 import com.scg.stop.global.domain.BaseTimeEntity;
-import jakarta.persistence.Column;
-import jakarta.persistence.Entity;
-import jakarta.persistence.GeneratedValue;
-import jakarta.persistence.Id;
-import jakarta.persistence.JoinColumn;
-import jakarta.persistence.ManyToOne;
+import com.scg.stop.notice.domain.Notice;
+import jakarta.persistence.*;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+import static jakarta.persistence.FetchType.LAZY;
+import static jakarta.persistence.GenerationType.IDENTITY;
+import static lombok.AccessLevel.PROTECTED;
+
 @Entity
 @Getter
 @NoArgsConstructor(access = PROTECTED)
@@ -46,4 +41,12 @@ public class File extends BaseTimeEntity {
     @ManyToOne(fetch = LAZY)
     @JoinColumn(name = "gallery_id")
     private Gallery gallery;
-}
+
+    public void setNotice(Notice notice) {
+        this.notice = notice;
+    }
+
+    public void setEventNotice(EventNotice eventNotice) {
+        this.eventNotice = eventNotice;
+    }
+}

src/main/java/com/scg/stop/domain/file/dto/response/FileResponse.java

@@ -0,0 +1,33 @@
+package com.scg.stop.domain.file.dto.response;
+
+import static lombok.AccessLevel.PRIVATE;
+
+import com.scg.stop.domain.file.domain.File;
+import java.time.LocalDateTime;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@NoArgsConstructor(access = PRIVATE)
+@AllArgsConstructor
+public class FileResponse {
+
+    private Long id;
+    private String uuid;
+    private String name;
+    private String mimeType;
+    private LocalDateTime createdAt;
+    private LocalDateTime updatedAt;
+
+    public static FileResponse from(File file) {
+        return new FileResponse(
+                file.getId(),
+                file.getUuid(),
+                file.getName(),
+                file.getMimeType(),
+                file.getCreatedAt(),
+                file.getUpdatedAt()
+        );
+    }
+}

src/main/java/com/scg/stop/domain/file/repository/FileRepository.java

@@ -0,0 +1,11 @@
+package com.scg.stop.domain.file.repository;
+
+import com.scg.stop.domain.file.domain.File;
+import java.util.List;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+public interface FileRepository extends JpaRepository<File, Long> {
+
+    List<File> findByIdIn(List<Long> ids);
+}

src/main/java/com/scg/stop/domain/notice/domain/Notice.java

@@ -1,42 +0,0 @@
-package com.scg.stop.domain.notice.domain;
-
-import static jakarta.persistence.FetchType.LAZY;
-import static jakarta.persistence.GenerationType.IDENTITY;
-import static lombok.AccessLevel.PROTECTED;
-
-import com.scg.stop.domain.file.domain.File;
-import com.scg.stop.global.domain.BaseTimeEntity;
-import jakarta.persistence.Column;
-import jakarta.persistence.Entity;
-import jakarta.persistence.GeneratedValue;
-import jakarta.persistence.Id;
-import jakarta.persistence.OneToMany;
-import java.util.ArrayList;
-import java.util.List;
-import lombok.Getter;
-import lombok.NoArgsConstructor;
-
-@Entity
-@Getter
-@NoArgsConstructor(access = PROTECTED)
-public class Notice extends BaseTimeEntity {
-
-    @Id
-    @GeneratedValue(strategy = IDENTITY)
-    private Long id;
-
-    @Column(nullable = false)
-    private String title;
-
-    @Column(nullable = false, columnDefinition = "TEXT")
-    private String content;
-
-    @Column(nullable = false)
-    private Integer hitCount = 0;
-
-    @Column(nullable = false, columnDefinition = "TINYINT(1)")
-    private boolean isFixed;
-
-    @OneToMany(fetch = LAZY, mappedBy = "notice")
-    private List<File> files = new ArrayList<>();
-}

src/main/java/com/scg/stop/event/controller/EventNoticeController.java

@@ -0,0 +1,69 @@
+package com.scg.stop.event.controller;
+
+
+import com.scg.stop.auth.annotation.AuthUser;
+import com.scg.stop.event.dto.request.EventNoticeRequest;
+import com.scg.stop.event.dto.response.EventNoticeListElementResponse;
+import com.scg.stop.event.dto.response.EventNoticeResponse;
+import com.scg.stop.event.service.EventNoticeService;
+import com.scg.stop.user.domain.AccessType;
+import com.scg.stop.user.domain.User;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.web.PageableDefault;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+@RequiredArgsConstructor
+@RequestMapping("/eventNotices")
+@RestController
+public class EventNoticeController {
+
+    private final EventNoticeService eventNoticeService;
+
+    // Create a new eventNotice
+    @PostMapping
+    public ResponseEntity<EventNoticeResponse> createEventNotice(
+            @RequestBody @Valid EventNoticeRequest createEventNoticeDto,
+            @AuthUser(accessType = {AccessType.ADMIN}) User user) {
+        return ResponseEntity.status(HttpStatus.CREATED).body(eventNoticeService.createEventNotice(createEventNoticeDto));
+    }
+
+    // Get a list of eventNotices
+    @GetMapping
+    public ResponseEntity<Page<EventNoticeListElementResponse>> getEventNoticeList(
+            @RequestParam(value = "title", required = false) String title,
+            @PageableDefault(page = 0, size = 10) Pageable pageable) {
+        Page<EventNoticeListElementResponse> eventNoticeList = eventNoticeService.getEventNoticeList(title, pageable);
+        return ResponseEntity.status(HttpStatus.OK).body(eventNoticeList);
+    }
+
+    // Get a corresponding eventNotice
+    @GetMapping("/{eventNoticeId}")
+    public ResponseEntity<EventNoticeResponse> getEventNotice(
+            @PathVariable("eventNoticeId") Long eventNoticeId) {
+        EventNoticeResponse eventNotice = eventNoticeService.getEventNotice(eventNoticeId);
+        return ResponseEntity.status(HttpStatus.OK).body(eventNotice);
+    }
+
+    // Update a corresponding eventNotice
+    @PutMapping("/{eventNoticeId}")
+    public ResponseEntity<EventNoticeResponse> updateEventNotice(
+            @PathVariable("eventNoticeId") Long eventNoticeId,
+            @RequestBody @Valid EventNoticeRequest updateEventNoticeDto,
+            @AuthUser(accessType = {AccessType.ADMIN}) User user) {
+        return ResponseEntity.status(HttpStatus.OK).body(eventNoticeService.updateEventNotice(eventNoticeId, updateEventNoticeDto));
+    }
+
+    // Delete a corresponding eventNotice
+    @DeleteMapping("/{eventNoticeId}")
+    public ResponseEntity<Long> deleteEventNotice(
+            @PathVariable("eventNoticeId") Long eventNoticeId,
+            @AuthUser(accessType = {AccessType.ADMIN}) User user) {
+        eventNoticeService.deleteEventNotice(eventNoticeId);
+        return ResponseEntity.noContent().build();
+    }
+}