Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT] 과제 제안 API 개발 & 이메일 API 개발 #68

Open
wants to merge 16 commits into
base: feat/46-proposal-api/base
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ out/
### VS Code ###
.vscode/

/src/main/resources/application-local.yml
/src/main/resources/application-oauth.yml
/src/main/resources/static/docs/
/src/main/resources/application-email.yml
/src/main/resources/static/docs/
9 changes: 9 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ dependencies {
runtimeOnly 'com.mysql:mysql-connector-j'
annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
developmentOnly 'org.springframework.boot:spring-boot-devtools'

//auth
implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
Expand All @@ -56,6 +57,13 @@ dependencies {
implementation 'io.micrometer:micrometer-registry-prometheus'

testRuntimeOnly 'org.junit.platform:junit-platform-launcher'

//email
implementation 'org.springframework.boot:spring-boot-starter-mail'

//thymeleaf(for email service)
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
implementation 'nz.net.ultraq.thymeleaf:thymeleaf-layout-dialect'
}

tasks.named('test') {
Expand Down Expand Up @@ -88,6 +96,7 @@ tasks.named('asciidoctor') {
build {
dependsOn copyDocument
}

allprojects {
repositories {
maven { url 'https://jitpack.io'}
Expand Down
32 changes: 32 additions & 0 deletions src/docs/asciidoc/eventNotice.adoc
Original file line number Diff line number Diff line change
@@ -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"]
====
23 changes: 23 additions & 0 deletions src/docs/asciidoc/eventPeriod.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
== 이벤트 기간 API
:source-highlighter: highlightjs

---
=== 이벤트 기간 생성 (POST /eventPeriods)
====
operation::event-period-controller-test/create-event-period[snippets="http-request,request-fields,http-response,response-fields"]
====

=== 올해의 이벤트 기간 조회 (GET /eventPeriod)
====
operation::event-period-controller-test/get-event-period[snippets="http-request,http-response,response-fields"]
====

=== 전체 이벤트 기간 리스트 조회 (GET /eventPeriods)
====
operation::event-period-controller-test/get-event-periods[snippets="http-request,http-response,response-fields"]
====

=== 올해의 이벤트 기간 업데이트 (PUT /eventPeriod)
====
operation::event-period-controller-test/update-event-period[snippets="http-request,request-fields,http-response,response-fields"]
====
11 changes: 9 additions & 2 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
:doctype: book
:source-highlighter: highlightjs
:toc: left
:toclevels: 3
:toclevels: 2
:seclinks:

=== 커스텀 예외 코드
include::{snippets}/exception-code-controller-test/get-exception-codes/exception-response-fields.adoc[]

include::auth-controller-test.adoc[]
// include::eventPeriod.adoc[] 컨트롤러별로 주석 지우고 문서 추가
include::jobInterview.adoc[]
include::talk.adoc[]
include::notice.adoc[]
include::eventNotice.adoc[]
include::eventPeriod.adoc[]
32 changes: 32 additions & 0 deletions src/docs/asciidoc/jobInterview.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
== 잡페어 인터뷰 API
:source-highlighter: highlightjs

---
=== 잡페어 인터뷰 생성 (POST /jobInterviews)
====
operation::job-interview-controller-test/create-job-interview[snippets="http-request,request-fields,http-response,response-fields"]
====

---
=== 잡페어 인터뷰 리스트 조회 (GET /jobInterviews)
====
operation::job-interview-controller-test/get-job-interview-list[snippets="http-request,query-parameters,http-response,response-fields"]
====

---
=== 잡페어 인터뷰 단건 조회 (GET /jobInterviews/{jobInterviewId})
====
operation::job-interview-controller-test/get-job-interview[snippets="http-request,path-parameters,http-response,response-fields"]
====

---
=== 잡페어 인터뷰 수정 (PUT /jobInterviews/{jobInterviewId})
====
operation::job-interview-controller-test/update-job-interview[snippets="http-request,path-parameters,request-fields,http-response,response-fields"]
====

---
=== 잡페어 인터뷰 삭제 (DELETE /jobInterviews/{jobInterviewId})
====
operation::job-interview-controller-test/delete-job-interview[snippets="http-request,path-parameters,http-response"]
====
32 changes: 32 additions & 0 deletions src/docs/asciidoc/notice.adoc
Original file line number Diff line number Diff line change
@@ -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"]
====
32 changes: 32 additions & 0 deletions src/docs/asciidoc/talk.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
== 대담 영상 API
:source-highlighter: highlightjs

---
=== 대담 영상 생성 (POST /talks)
====
operation::talk-controller-test/create-talk[snippets="http-request,request-fields,http-response,response-fields"]
====

---
=== 대담 영상 리스트 조회 (GET /talks)
====
operation::talk-controller-test/get-talk-list[snippets="http-request,query-parameters,http-response,response-fields"]
====

---
=== 대담 영상 단건 조회 (GET /talks/{talkId})
====
operation::talk-controller-test/get-talk[snippets="http-request,path-parameters,http-response,response-fields"]
====

---
=== 대담 영상 수정 (PUT /talks/{talkId})
====
operation::talk-controller-test/update-talk[snippets="http-request,path-parameters,request-fields,http-response,response-fields"]
====

---
=== 대담 영상 삭제 (DELETE /talks/{talkId})
====
operation::talk-controller-test/delete-talk[snippets="http-request,path-parameters,http-response"]
====
9 changes: 4 additions & 5 deletions src/main/java/com/scg/stop/StopApplication.java
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

}
}
42 changes: 0 additions & 42 deletions src/main/java/com/scg/stop/domain/event/domain/EventNotice.java

This file was deleted.

14 changes: 11 additions & 3 deletions src/main/java/com/scg/stop/domain/file/domain/File.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
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.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;
Expand Down Expand Up @@ -46,4 +46,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;
}
}
Original file line number Diff line number Diff line change
@@ -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()
);
}
}
Original file line number Diff line number Diff line change
@@ -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);
}
42 changes: 0 additions & 42 deletions src/main/java/com/scg/stop/domain/notice/domain/Notice.java

This file was deleted.

Loading