REST API

1. Introduction

다음은 HEARUS-SPRING-BACKEND 프로젝트의 공식 API 문서입니다. 이 문서에서는 API 엔드포인트와 API 사용 방법에 대한 세부 사항을 확인할 수 있습니다.

2. Endpoints Overview

각 엔드포인트에 대한 간단한 리스트와 설명을 제공합니다.

• User Endpoints: /users, /login
• Product Endpoints: /products, /products/{id}
• Order Endpoints: /orders, /orders/{id}

각 엔드포인트에 대한 간단한 설명과 HTTP 메서드(GET, POST 등)를 포함합니다.

3. Error Handling

Hearus Spring Backend 에서 사용하는 공통적인 에러 코드들을 설명합니다.

• 400 Bad Request: 클라이언트 요청 오류. (필수 파라미터 누락 등)
• 401 Unauthorized: 인증 오류. (Bearer 토큰 인증 실패, 토큰 누락 등)
• 404 Not Found: 리소스 미발견.
• 409 Conflict: 서버의 현재 상태와 클라이언트 요청이 충돌 (중복 회원 가입 등)
• 500 Internal Server Error: 서버 오류.

4. Basic Response

API 요청에 따른 기본적인 응답 구조는 다음과 같습니다.

이름	타입	설명	필수
status	String	HTTP 상태 메시지	O
msg	String	요청에 대한 상세 메시지	O
obj	Object	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청의 성공 여부	O

응답 예시

{
  "status": "200 OK",
  "msg": "요청이 성공적으로 처리되었습니다.",
  "obj":{
      "id": 1,
      "name": "Sample Object 1"
   },
  "success": true
}

{
  "status": "404 NOT FOUND",
  "msg": "요청에 대한 자원이 없습니다.",
  "obj": null,
  "success": false
}

5. Detailed API Documentation

각 API 엔드포인트는 특정 기능을 수행하며, 사용자는 이를 통해 서버와 상호작용할 수 있습니다. 모든 API는 HTTP 메서드를 통해 접근되며, 요청과 응답은 JSON 형식으로 이루어집니다. 아래는 각 API 엔드포인트에 대한 상세한 설명입니다.

이 문서는 클라이언트와 서버 간의 원활한 통신을 돕기 위한 가이드로, 각 엔드포인트의 역할, 필요한 요청 매개변수, 그리고 응답 형식을 포함합니다. 이를 통해 개발자는 보다 쉽게 API를 이해하고 사용할 수 있으며, 유지 보수 및 확장이 용이한 구조로 관리됩니다.

Auth API

1. 회원가입

- 기본정보

HTTP Method	Endpoint
POST	/api/v1/auth/signup

- 요청

본문

이름	타입	설명	필수
userName	String	회원가입할 사용자 이름	O
userEmail	String	회원가입할 사용자 이메일 (이메일 형식)	O
userPassword	String	회원가입할 사용자 비밀번호 (8자 이상)	O
userIsOAuth	String	OAuth 사용 여부	X

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Object	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

- 예제

요청

curl -X 'POST' \
  'https://www.hearus-spring-be.shop:8080/api/v1/auth/signup' \
  -H 'accept: application/hal+json' \
  -H 'Content-Type: application/json' \
  -d '{
  "userEmail": "[email protected]",
  "userPassword": "testtest123@",
  "userIsOAuth": false,
  "userName": "김히얼"
}'

응답

{
  "status": "CREATED",
  "msg": "Signup Success",
  "object": null,
  "success": true
}

2. 로그인

- 기본정보

HTTP Method	Endpoint
POST	/api/v1/auth/login

- 요청

본문

이름	타입	설명	필수
userEmail	String	로그인할 사용자 이메일 (이메일 형식)	O
userPassword	String	로그인할 사용자 비밀번호 (8자 이상)	O
userIsOAuth	String	OAuth 사용 여부	X

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	TokenDTO	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

TokenDTO

이름	타입	설명	필수
grantType	String	Http 상태 메시지인증 방식, 여기는 "Bearer"로 accessToken을 사용한 인증을 의미	O
accessToken	String	서버에 요청 시 사용하는 인증 토큰	O
refreshToken	String	accessToken 만료 시 새로 발급받기 위한 토큰	O

- 예제

요청

curl -X 'POST' \
  'https://www.hearus-spring-be.shop:8080/api/v1/auth/login' \
  -H 'accept: application/hal+json' \
  -H 'Content-Type: application/json' \
  -d '{
  "userEmail": "[email protected]",
  "userPassword": "testtest123@"
}'

응답

{
  "status": "OK",
  "msg": "Login Success",
  "object": {
    "grantType": "Bearer",
    "accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxNjRiNTkwNy01ZTU2LTQyODMtYTdlYS00NWY3MzBlMTkzZDciLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTQzNDU2Nn0.Hh1y8nV3MnoQObaTaEWDTNZ26ub3qKgWD6KUWb9ij7g",
    "refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3Mjg2NTY5NjZ9.NIlH7ua6lsZN5ku88QzNJPiU2ny9xmpSlo4PtIgdAbI"
  },
  "success": true
}

User API

1. 현재 로그인한 유저 정보 조회

- 기본정보

HTTP Method	Endpoint
GET	/api/v1/user/present-user

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	User	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

User

이름	타입	설명	필수
userId	String	사용자 ID	O
userName	String	사용자 이름	O
userEmail	String	사용자 이메일	O
userPassword	String	빈 문자열 반환	O
userRole	String	사용자 Role	O
userIsOAuth	Boolean	OAuth 로그인 여부	O
userOAuthType	String	OAuth Third-Party 이름	O
userSchool	String	사용자 학교	O
userMajor	String	사용자 전공	O
userGrade	String	사용자 학년	O
userSavedLectures	String[]	사용자가 저장한 강의 ID 리스트	O
userSchedule	String[]	사용자가 저장한 시간표 ID 리스트	O
userUsePurpose	String	사용자 이용 목적	O

- 예제

요청

curl -X 'GET' \
  'https://www.hearus-spring-be.shop:8080/api/v1/user/present-user' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTkyNzIzMH0.iBwrCcMA4kA1HUM87eB_jJeZNsvxeqNSzxvXPY8EtmY'

응답

{
  "status": "OK",
  "msg": "Success Search User",
  "object": {
    "userId": "74b63644-9507-4b64-9670-ae5d0ea8dc31",
    "userName": "김히얼",
    "userEmail": "[email protected]",
    "userPassword": "",
    "userRole": "USER",
    "userIsOAuth": false,
    "userOAuthType": null,
    "userSchool": "건국대학교",
    "userMajor": "경제학과",
    "userGrade": "3",
    "userSavedLectures": [
      "6694b81c95105f1845ebf05a",
      "6694b82695105f1845ebf05b",
      "6694b82e95105f1845ebf05c",
      "6694b83495105f1845ebf05d",
      "6694b83c95105f1845ebf05e",
      "66aa36b94771e246390c5b96",
      "66fe5620fa14c6267fac4917",
      "66fe5f58493e974a73d6aa30",
      "66fe620d493e974a73d6aa34",
      "66fe807ae88f3b486857b245",
      "66fe8a9a6f5c5d29e7d9daea",
      "66fe8c7c6f5c5d29e7d9daeb",
      "66fe8ed36f5c5d29e7d9daec",
      "66ff7e38ba956a6047381f05",
      "66ff9dd4ba956a6047381f06",
      "67049ef5ba956a6047381f09",
      "6704e586ba956a6047381f0a",
      "670528813c434b411544212c",
      "670529f63c434b411544212d",
      "67061ecbdcd9ed61857069c0",
      "67062d80dcd9ed61857069c1",
      "67062e0edcd9ed61857069c2",
      "67063accdcd9ed61857069c3",
      "67063f1bdcd9ed61857069c4",
      "67064023dcd9ed61857069c5",
      "670640d5dcd9ed61857069c6",
      "67064102dcd9ed61857069c7",
      "670641fcdcd9ed61857069c8",
      "67064662dcd9ed61857069c9",
      "6706492edcd9ed61857069ca",
      "67065f6ddcd9ed61857069cb",
      "67065feddcd9ed61857069cc",
      "67066059dcd9ed61857069cd",
      "670665a3dcd9ed61857069ce",
      "6706662ddcd9ed61857069cf",
      "670666e9dcd9ed61857069d0",
      "67066726dcd9ed61857069d1",
      "67066a13dcd9ed61857069d2",
      "6706705fdcd9ed61857069d3",
      "670671cfdcd9ed61857069d4",
      "67067200dcd9ed61857069d5",
      "67067227dcd9ed61857069d6",
      "67067258dcd9ed61857069d7",
      "67067270dcd9ed61857069d8",
      "67067399dcd9ed61857069d9",
      "670673c4dcd9ed61857069da",
      "67067982dcd9ed61857069db",
      "6706799ddcd9ed61857069dc",
      "67067fbbdcd9ed61857069dd"
    ],
    "userSchedule": [
      "1",
      "11",
      "14",
      "15"
    ],
    "userUsePurpose": null
  },
  "success": true
}

2. 사용자 정보 업데이트

- 기본정보

HTTP Method	Endpoint
PUT	/api/v1/schedule/updateUser

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
userId	String	사용자 ID	O
userName	String	변경할 사용자 이름	O
userSchool	String	변경할 사용자 학교	O
userMajor	String	변경할 사용자 전공	O
userGrade	String	변경할 사용자 학년	O
userUsePurpose	String	변경할 사용자 이용 목적	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Object	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

- 예제

요청

curl -X 'PUT' \
  'https://www.hearus-spring-be.shop:8080/api/v1/user/updateUser' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTkyNzIzMH0.iBwrCcMA4kA1HUM87eB_jJeZNsvxeqNSzxvXPY8EtmY' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "74b63644-9507-4b64-9670-ae5d0ea8dc31",
    "userName": "김히얼",
    "userSchool": "건국대학교",
    "userMajor": "경제학과",
    "userGrade": "3",
    "userUsePurpose": null
  }'

응답

{
  "status": "OK",
  "msg": "User updated successfully",
  "object": null,
  "success": true
}

Lecture API - Lecture

1. 강의 추가

- 기본정보

HTTP Method	Endpoint
POST	/api/v1/lecture/addLecture

- 요청

본문

이름	타입	설명	필수
name	String	강의 이름	O
processedScript	String[]	녹음된 강의 스크립트	O
lectureDate	Date	강의 날짜	O
scheduleElementId	String	강의와 연관된 ScheduleElement 의 ID	X
createdAt	Date	생성된 날짜	X
problems	Problem[]	생성된 문제	X

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Lecture	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

Lecture

이름	타입	설명	필수
id	String	강의 ID	O
name	String	강의 이름	O
processedScript	String[]	녹음된 강의 스크립트	O
scheduleElementId	String	연관된 ScheduleElement의 ID	O
lectureDate	Date	강의 날짜	O
createdAt	Date	생성된 날짜	O
problems	Problem[]	강의와 관련된 문제들. Null 일 수 있음.	O

Problem

이름	타입	설명	필수
id	String	문제 ID	O
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	O

- 예제

요청

curl -X 'POST' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/addLecture' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTkyNzIzMH0.iBwrCcMA4kA1HUM87eB_jJeZNsvxeqNSzxvXPY8EtmY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "컴퓨터공학개론",
  "processedScript": [
"안녕하세요 김교수입니다"
   
  ],

"lectureDate": "2023-07-30T11:00:00"
}'

응답

{
  "status": "OK",
  "msg": "Lecture added successfully",
  "object": {
    "id": "670fc1191c0bc5033cb8056d",
    "name": "컴퓨터공학개론",
    "processedScript": [
      "안녕하세요 김교수입니다"
    ],
    "scheduleElementId": null,
    "lectureDate": "2023-07-30T11:00:00.000+00:00",
    "createdAt": "2024-10-16T13:35:21.997+00:00",
    "problems": null
  },
  "success": true
}

2. 모든 강의 조회

- 기본정보

HTTP Method	Endpoint
GET	/api/v1/lecture/getAllLecture

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Lecture[]	강의 정보를 가짐. 빈 리스트일 수 있음	O
success	Boolean	요청 성공 여부	O

Lecture

이름	타입	설명	필수
id	String	강의 ID	O
name	String	강의 이름	O
processedScript	String[]	녹음된 강의 스크립트	O
scheduleElementId	String	연관된 ScheduleElement의 ID	O
lectureDate	Date	강의 날짜	O
createdAt	Date	생성된 날짜	O
problems	Problem[]	강의와 관련된 문제들. Null 일 수 있음.	O

Problem

이름	타입	설명	필수
id	String	문제 ID	O
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	O

- 예제

요청

curl -X 'GET' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/getAllLecture' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTkyNzIzMH0.iBwrCcMA4kA1HUM87eB_jJeZNsvxeqNSzxvXPY8EtmY'

응답

{
  "status": "OK",
  "msg": "LectureLists",
  "object": [
    {
      "id": "6694b81c95105f1845ebf05a",
      "name": "경제학원론-240911",
      "processedScript": [
        "안녕하세요. 오늘은 **수요와 공급**이라는 경제학의 가장 기본적인 개념에 대해 자세히 알아보겠습니다.먼저 **수요**에 대해 이야기해 볼까요? 수요란 **소비자**들이 어떤 상품"
      ],
      "scheduleElementId": "14",
      "lectureDate": "2024-09-11T09:00:00.000+00:00",
      "createdAt": "2024-09-11T05:48:12.451+00:00",
      "problems": null
    },
    {
      "id": "6694b82695105f1845ebf05b",
      "name": "경제학원론-240904",
      "processedScript": [
        "안녕하세요. 오늘부터 경제학원론 수업을 시작하겠습니다. 첫 시간에는 **경제학의 기본 개념**과 **경제학을 공부하는 이유**에 대해 알아보겠습니다.먼저, **경제학**이란 무엇일"
      ],
      "scheduleElementId": "14",
      "lectureDate": "2024-09-04T13:30:00.000+00:00",
      "createdAt": "2024-09-04T05:48:22.313+00:00",
      "problems": null
    },
    {
      "id": "6694b82e95105f1845ebf05c",
      "name": "컴퓨팅적사고-240903",
      "processedScript": [
        "안녕하세요. 오늘부터 **파이썬을 활용한 컴퓨팅적 사고** 수업을 시작하겠습니다. 첫 시간에는 **컴퓨팅적 사고**의 개념과 **파이썬 프로그래밍**의 기초에 대해 알아보겠습니다."
      ],
      "scheduleElementId": "12",
      "lectureDate": "2024-09-03T10:30:00.000+00:00",
      "createdAt": "2024-07-15T05:48:30.618+00:00",
      "problems": null
    },
    {
      "id": "6694b83495105f1845ebf05d",
      "name": "동아리 회의-240902",
      "processedScript": [
        "안녕하세요, 여러분. 오늘은 경제학과 논문 동아리의 첫 번째 모임입니다. 이 시간에는 우리 동아리의 **목적**과 **활동 계획**, 그리고 **논문 작성의 기초**에 대해 이야기"
      ],
      "scheduleElementId": null,
      "lectureDate": "2024-09-02T14:00:00.000+00:00",
      "createdAt": "2024-07-15T05:48:36.706+00:00",
      "problems": null
    }
  ],
  "success": true
}

3. 강의 조회

- 기본정보

HTTP Method	Endpoint
GET	/api/v1/lecture/getLecture

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
lectureId	String	조회할 강의의 ID	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Lecture	강의 정보를 가짐. 빈 리스트일 수 있음	O
success	Boolean	요청 성공 여부	O

Lecture

이름	타입	설명	필수
id	String	강의 ID	O
name	String	강의 이름	O
processedScript	String[]	녹음된 강의 스크립트	O
scheduleElementId	String	연관된 ScheduleElement의 ID	O
lectureDate	Date	강의 날짜	O
createdAt	Date	생성된 날짜	O
problems	Problem[]	강의와 관련된 문제들. Null 일 수 있음.	O

Problem

이름	타입	설명	필수
id	String	문제 ID	O
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	O

- 예제

요청

curl -X 'GET' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/getLecture?lectureId=6694b81c95105f1845ebf05a' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTc3NTg1Nn0.GpyInbVf4nmIzm45mspSv6bsN1hw8Cl0Zut3nOEi-0k'

응답

{
  "status": "OK",
  "msg": "LectureModel",
  "object": {
    "id": "6694b81c95105f1845ebf05a",
    "name": "경제학원론-240911",
    "processedScript": [
      "안녕하세요. 오늘은 **수요와 공급**이라는 경제학의 가장 기본적인 개념에 대해 자세히 알아보겠습니다.",
      "먼저 **수요**에 대해 이야기해 볼까요? 수요란 **소비자**들이 어떤 상품이나 서비스를 **구매하려는 욕구**를 말합니다. 수요는 **가격**과 **밀접한 관련**이 있어요. 보통 가격이 올라가면 수요가 줄어들고, 가격이 내려가면 수요가 늘어납니다. 이를 **수요의 법칙**이라고 해요.",
      "수요에 영향을 미치는 요인들은 여러 가지가 있습니다. **소득**, **취향**, **다른 상품의 가격**, **미래에 대한 예상** 등이 대표적이에요. 예를 들어, 소비자의 소득이 늘어나면 대부분의 상품에 대한 수요가 증가합니다.",
      "이제 **공급**에 대해 알아볼까요? 공급은 **생산자**들이 어떤 상품이나 서비스를 **판매하려는 의지**를 말합니다. 공급 역시 가격과 밀접한 관련이 있어요. 보통 가격이 올라가면 공급이 늘어나고, 가격이 내려가면 공급이 줄어듭니다. 이를 **공급의 법칙**이라고 합니다.",
      "공급에 영향을 미치는 요인으로는 **생산 비용**, **기술**, **정부 정책**, **미래에 대한 예상** 등이 있습니다. 예를 들어, 새로운 기술이 개발되어 생산 비용이 줄어들면 공급이 증가하게 됩니다.",
      "**수요와 공급**이 만나는 지점에서 **시장 균형**이 형성됩니다. 이때의 가격을 **균형 가격**, 거래량을 **균형 거래량**이라고 해요. 시장 균형에서는 **초과 수요**나 **초과 공급**이 없는 상태입니다.",
      "하지만 현실에서는 항상 균형 상태에 있지는 않습니다. 가격이 균형 가격보다 높으면 **초과 공급**이 발생하고, 낮으면 **초과 수요**가 발생해요. 이런 불균형 상태에서 시장은 다시 균형을 찾아가는 **조정 과정**을 거치게 됩니다.",
      "**탄력성**이라는 개념도 중요해요. 탄력성은 한 변수의 변화에 대해 다른 변수가 얼마나 민감하게 반응하는지를 나타냅니다. **수요의 가격 탄력성**은 가격 변화에 따라 수요량이 얼마나 변하는지를 측정합니다. 필수품은 보통 비탄력적이고, 사치품은 탄력적인 경향이 있어요.",
      "**소비자 잉여**와 **생산자 잉여**라는 개념도 알아둘 필요가 있습니다. 소비자 잉여는 소비자가 실제로 지불한 가격과 지불할 용의가 있었던 최대 가격의 차이예요. 생산자 잉여는 생산자가 받은 가격과 최소한 받고자 했던 가격의 차이를 말합니다.",
      "마지막으로, 시장에 대한 **정부의 개입**에 대해 이야기해 볼까요? 정부는 때때로 **최저 가격제**나 **최고 가격제**를 통해 시장에 개입합니다. 이는 **시장의 비효율성**을 해결하거나 **사회적 형평성**을 높이기 위한 목적으로 시행되지만, 때로는 **의도하지 않은 결과**를 낳기도 합니다.",
      "이상으로 수요와 공급에 대한 기본적인 개념들을 살펴보았습니다. 다음 시간에는 이러한 개념들이 실제 경제 현상에 어떻게 적용되는지 구체적인 사례를 통해 알아보도록 하겠습니다. 질문 있으신가요?"
    ],
    "scheduleElementId": "경제학원론",
    "lectureDate": "2024-09-11T09:00:00.000+00:00",
    "createdAt": "2024-09-11T05:48:12.451+00:00",
    "problems": [
      {
        "id": "e83564dd-3e3d-490b-a6fc-af90682d4775",
        "type": "OXChoice",
        "direction": "기회비용은 선택에 따른 명시적 비용만을 고려한다.",
        "options": null,
        "answer": "X"
      }
    ]
  },
  "success": true
}

4. 스케줄 정보를 이용하여 강의 조회

- 기본정보

HTTP Method	Endpoint
GET	/api/v1/lecture/getLectureByScheduleElement

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

쿼리 파라미터

이름	타입	설명	필수
scheduleElementId	String	스케줄 정보 ID	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Lecture[]	강의 정보를 가짐. 빈 리스트일 수 있음	O
success	Boolean	요청 성공 여부	O

Lecture

이름	타입	설명	필수
id	String	강의 ID	O
name	String	강의 이름	O
processedScript	String[]	녹음된 강의 스크립트	O
scheduleElementId	String	연관된 ScheduleElement의 ID	O
lectureDate	Date	강의 날짜	O
createdAt	Date	생성된 날짜	O
problems	Problem[]	강의와 관련된 문제들. Null 일 수 있음.	O

Problem

이름	타입	설명	필수
id	String	문제 ID	O
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	O

- 예제

요청

curl -X 'GET' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/getLectureByScheduleElement?scheduleElementId=12' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTc3NTg1Nn0.GpyInbVf4nmIzm45mspSv6bsN1hw8Cl0Zut3nOEi-0k'

응답

{
  "status": "OK",
  "msg": "Lectures retrieved successfully",
  "object": [
    {
      "id": "6694b82e95105f1845ebf05c",
      "name": "컴퓨팅적사고-240903",
      "processedScript": null,
      "scheduleElementId": "12",
      "lectureDate": "2024-09-03T10:30:00.000+00:00",
      "createdAt": "2024-07-15T05:48:30.618+00:00",
      "problems": null
    },
    {
      "id": "67061ecbdcd9ed61857069c0",
      "name": "새로운 녹음-241009-컴사",
      "processedScript": null,
      "scheduleElementId": "12",
      "lectureDate": "2024-10-09T15:12:26.000+00:00",
      "createdAt": "2024-10-09T06:12:27.589+00:00",
      "problems": null
    }
  ],
  "success": true
}

5. 강의 업데이트

- 기본정보

HTTP Method	Endpoint
PUT	/api/v1/lecture/updateLecture

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
id	String	타겟 강의 ID	O
name	String	변경할 강의 이름	O
processedScript	String[]	변경할 녹음된 강의 스크립트	O
scheduleElementId	String	변경할 연관된 ScheduleElement의 ID	O
lectureDate	Date	변경할 강의 날짜	O
createdAt	Date	변경할 생성된 날짜	O
problems	Problem[]	변경할 강의와 관련된 문제들. Null 일 수 있음.	O

Problem

이름	타입	설명	필수
id	String	문제 ID	O
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Lecture	강의 정보를 가짐. Null 일 수 있음	O
success	Boolean	요청 성공 여부	O

Lecture

이름	타입	설명	필수
id	String	강의 ID	O
name	String	변경된 강의 이름	O
processedScript	String[]	변경된 녹음된 강의 스크립트	O
scheduleElementId	String	변경된 연관된 ScheduleElement의 ID	O
lectureDate	Date	변경된 강의 날짜	O
createdAt	Date	변경된 생성된 날짜	O
problems	Problem[]	변경된 강의와 관련된 문제들. Null 일 수 있음.	O

Problem

이름	타입	설명	필수
id	String	문제 ID	O
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	O

- 예제

요청

curl -X 'PUT' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/updateLecture' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTc3NTg1Nn0.GpyInbVf4nmIzm45mspSv6bsN1hw8Cl0Zut3nOEi-0k' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "6706799ddcd9ed61857069dc",
    "name": "경제학원론_2023-07-01",
    "processedScript": [
        "경제학은 우리 주변의 다양한 경제 현상을 이해하고 분석하는 데 도움이 되는 중요한 학문입니다",
        "특히, 최근에는 경제적 불평등, 기후 변화, 글로벌 경제 위기 등 다양한 경제 문제들이 우리 사회에 큰 영향을 미치고 있습니다.",
        "경제학은 희소한 자원이라는 제약 조건 하에서 인간의 욕구를 충족시키기 위한 선택과 행동을 연구하는 사회과학입니다.",
        "긍정적 분석은 경제 현상이 어떻게 작동하는지를 설명하는 데 초점을 맞춥니다. 경제 모델, 통계 분석, 실험 등 다양한 방법을 사용하여 경제 현상을 객관적으로 분석합니다.",
        "규범적 분석은 경제 현상이 어떻게 작동해야 하는지에 대한 판단을 내리는 데 초점을 맞춥니다. 경제 정책, 윤리적 고려, 가치 판단 등을 통해 경제 현상에 대한 바람직한 방향을 제시합니다."
    ],
    "scheduleElementId": "2",
    "lectureDate": "2023-07-01T11:30:00.000+00:00",
    "createdAt": "2024-06-30T09:20:31.376+00:00",
    "problems": []
}'

응답

{
  "status": "OK",
  "msg": "Lecture Updated",
  "object": {
    "id": "6706799ddcd9ed61857069dc",
    "name": "경제학원론_2023-07-01",
    "processedScript": [
      "경제학은 우리 주변의 다양한 경제 현상을 이해하고 분석하는 데 도움이 되는 중요한 학문입니다",
      "특히, 최근에는 경제적 불평등, 기후 변화, 글로벌 경제 위기 등 다양한 경제 문제들이 우리 사회에 큰 영향을 미치고 있습니다.",
      "경제학은 희소한 자원이라는 제약 조건 하에서 인간의 욕구를 충족시키기 위한 선택과 행동을 연구하는 사회과학입니다.",
      "긍정적 분석은 경제 현상이 어떻게 작동하는지를 설명하는 데 초점을 맞춥니다. 경제 모델, 통계 분석, 실험 등 다양한 방법을 사용하여 경제 현상을 객관적으로 분석합니다.",
      "규범적 분석은 경제 현상이 어떻게 작동해야 하는지에 대한 판단을 내리는 데 초점을 맞춥니다. 경제 정책, 윤리적 고려, 가치 판단 등을 통해 경제 현상에 대한 바람직한 방향을 제시합니다."
    ],
    "scheduleElementId": "2",
    "lectureDate": "2023-07-01T11:30:00.000+00:00",
    "createdAt": "2024-06-30T09:20:31.376+00:00",
    "problems": []
  },
  "success": true
}

6. 강의 삭제

- 기본정보

HTTP Method	Endpoint
DELETE	/api/v1/lecture/deleteLecture

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
lectureId	String	삭제할 강의의 ID	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Object	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

- 예제

요청

curl -X 'DELETE' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/deleteLecture' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTc3NTg1Nn0.GpyInbVf4nmIzm45mspSv6bsN1hw8Cl0Zut3nOEi-0k' \
  -H 'Content-Type: application/json' \
  -d '{
  "lectureId": "66aa36b14771e246390c5b95"
}'

응답

{
  "status": "OK",
  "msg": "Lecture Deleted successfully",
  "object": null,
  "success": true
}

Lecture API - Problem

1. 문제 추가

- 기본정보

HTTP Method	Endpoint
POST	/api/v1/lecture/addProblem

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
lectureId	String	문제를 추가할 강의의 ID	O
problem	Problem	추가할 문제	O

Problem

이름	타입	설명	필수
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	X
id	String	문제 ID	X

-type-
MultipleChoice : 객관식, Option은 네개, 즉 사지선다형
ShrotAnswer : 단답형
BlanckQuestion : 빈칸 뚫기 문제
OXChoice : O X 문제

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Problem[]	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

Problem

이름	타입	설명	필수
id	String	추가된 문제의 ID	O
type	String	추가된 문제의 타입	O
direction	String	추가된 문제의 내용	O
option	String	추가된 문제의 옵션	O
answer	String	추가된 문제의 정답	O

- 예제

요청

curl -X 'POST' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/addProblem' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTc3Mzc2Nn0.ENuQLg6McYmBnso8nXC7IgM2hFAgKJwYYZfooCfgmOU' \
  -H 'Content-Type: application/json' \
  -d '{
  "lectureId": "6694b81c95105f1845ebf05a",
  "problem": {
    "type": "OXChoice",
    "direction": "기회비용은 선택에 따른 명시적 비용만을 고려한다.",
    "answer": "X"
  }
} '

응답

{
  "status": "OK",
  "msg": "Problem Added",
  "object": [
    {
      "id": "678c9ead-60ac-479d-a933-096671f684ff",
      "type": "OXChoice",
      "direction": "기회비용은 선택에 따른 명시적 비용만을 고려한다.",
      "options": null,
      "answer": "X"
    }
  ],
  "success": true
}

2. 문제 조회

- 기본정보

HTTP Method	Endpoint
GET	/api/v1/lecture/getProblem

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

쿼리 파라미터

이름	타입	설명	필수
lectureId	String	문제를 조회할 강의 ID	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Problem[]	문제 정보를 가짐. 빈 리스트일 수 있음	O
success	Boolean	요청 성공 여부	O

Problem

이름	타입	설명	필수
id	String	문제 ID	O
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	O

- 예제

요청

curl -X 'GET' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/getProblem?lectureId=6694b81c95105f1845ebf05a' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTc3NTg1Nn0.GpyInbVf4nmIzm45mspSv6bsN1hw8Cl0Zut3nOEi-0k'

응답

{
  "status": "OK",
  "msg": "LectureModel",
  "object": [
    {
      "id": "678c9ead-60ac-479d-a933-096671f684ff",
      "type": "OXChoice",
      "direction": "기회비용은 선택에 따른 명시적 비용만을 고려한다.",
      "options": null,
      "answer": "X"
    }
  ],
  "success": true
}

3. 문제 삭제

- 기본정보

HTTP Method	Endpoint
DELETE	/api/v1/lecture/deleteProblem

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
lectureId	String	삭제할 문제가 포함된 강의의 ID	O
problemId	String	삭제할 문제의 ID	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Problem[]	삭제 후 남은 Problem들을 가짐.	O
success	Boolean	요청 성공 여부	O

Problem

이름	타입	설명	필수
id	String	문제의 ID	O
type	String	문제의 타입	O
direction	String	문제의 내용	O
option	String	문제의 옵션	O
answer	String	문제의 정답	O

- 예제

요청

curl -X 'DELETE' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/deleteProblem' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTc3NTg1Nn0.GpyInbVf4nmIzm45mspSv6bsN1hw8Cl0Zut3nOEi-0k' \
  -H 'Content-Type: application/json' \
  -d '{
  "lectureId": "6694b81c95105f1845ebf05a",
  "problemId": "678c9ead-60ac-479d-a933-096671f684ff"
}'

응답

{
  "status": "OK",
  "msg": "Lecture Updated",
  "object": [
    {
      "id": "74dcb2b4-7d9d-452c-8ac9-64f3fc8b1a28",
      "type": "OXChoice",
      "direction": "기회비용은 선택에 따른 명시적 비용만을 고려한다.",
      "options": [],
      "answer": "X"
    },
    {
      "id": "3c1ff98e-4f4c-4877-8a41-d1e4807ecaf1",
      "type": "OXChoice",
      "direction": "기회비용은 선택에 따른 명시적 비용만을 고려한다.",
      "options": [],
      "answer": "X"
    }
  ],
  "success": true
}

Lecture API - Script

1. 스크립트 업데이트

- 기본정보

HTTP Method	Endpoint
PUT	/api/v1/lecture/putScript

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
lectureId	String	스크립트를 변경할 강의 ID	O
script	String	추가할 스크립트	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Lecture	강의 정보를 가짐. Null 일 수 있음	O
success	Boolean	요청 성공 여부	O

Lecture

이름	타입	설명	필수
id	String	강의 ID	O
name	String	강의 이름	O
processedScript	String[]	녹음된 강의 스크립트	O
scheduleElementId	String	연관된 ScheduleElement의 ID	O
lectureDate	Date	강의 날짜	O
createdAt	Date	생성된 날짜	O
problems	Problem[]	강의와 관련된 문제들. Null 일 수 있음.	O

Problem

이름	타입	설명	필수
id	String	문제 ID	O
type	String	문제의 유형	O
direction	String	문제 내용	O
answer	String	문제의 답	O
options	String[]	문제의 선지	O

- 예제

요청

curl -X 'PUT' \
  'https://www.hearus-spring-be.shop:8080/api/v1/lecture/putScript' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTc3NTg1Nn0.GpyInbVf4nmIzm45mspSv6bsN1hw8Cl0Zut3nOEi-0k' \
  -H 'Content-Type: application/json' \
  -d '{
  "lectureId": "670528813c434b411544212c",
  "script": "추가된 스크립트1"
 
}'

응답

{
  "status": "OK",
  "msg": "Lecture ProcessedScript Added",
  "object": {
    "id": "670528813c434b411544212c",
    "name": "새로운 녹음-241008",
    "processedScript": [
      "**안녕하세요!** 반가워요. **로라고십입니다**, 다시 봐라, 주시스하고 싶다고요.",
      "",
      "**지금 기다리는 것은 하나만입니다. 근데 왜 안 오실까요?**",
      "**어야 합니다. 궁금한 길이예요?**",
      "**하지만** 많이 발음하고 있습니다.",
      "**문장1**, **문장2**, ...",
      "**문단1**, **문단2**, ...",
      "**마지막 문단**",
      "**안녕하세요!** 반가워요. **로라고십입니다**, 다시 봐라, 주시스하고 싶다고요.",
      "추가된 스크립트1"
    ],
    "scheduleElementId": null,
    "lectureDate": "2024-10-08T21:41:37.000+00:00",
    "createdAt": "2024-10-08T12:41:37.275+00:00",
    "problems": []
  },
  "success": true
}

Schedule API - Schedule

1. 시간표 생성

- 기본정보

HTTP Method	Endpoint
POST	/api/v1/schedule/addSchedule

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
name	String	생성할 시간표 이름	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Object	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

- 예제

요청

curl -X 'POST' \
  'https://www.hearus-spring-be.shop:8080/api/v1/schedule/addSchedule' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTg3NzEzM30.7mekmYlkvjQmd6mxh7YnnsbXfDdcYwU4Fr-laMLdy3I' \
  -H 'Content-Type: application/json' \
  -d '{
"name":"김히얼의 시간표"
}'

응답

{
  "status": "CREATED",
  "msg": "Schedule Created",
  "object": null,
  "success": true
}

2. 시간표 조회

- 기본정보

HTTP Method	Endpoint
GET	/api/v1/schedule/getSchedule

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

쿼리 파라미터

이름	타입	설명	필수
name	String	조회할 시간표 이름	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Schedule	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

Schedule

이름	타입	설명	필수
id	Integer	시간표 ID	O
scheduleElements	ScheduleElement[]	시간표에 포함되어 있는 스케줄	O
name	String	시간표 이름	O
userId	String	생성한 유저 ID	X

ScheduleElement

이름	타입	설명	필수
id	Integer	스케줄 ID	O
scheduleId	Integer	해당 스케줄을 포함하는 시간표 ID	O
name	String	스케줄 이름	O
location	String	스케줄 진행 장소	O
dayOfWeek	String	스케줄 진행 요일	O
color	String	스케줄을 표시할 UI의 색상	O
startTime	String	스케줄 시작 시간	O
endTime	String	스케줄 종료 시간	O

- 예제

요청

curl -X 'GET' \
  'https://www.hearus-spring-be.shop:8080/api/v1/schedule/getSchedule?name=%EA%B9%80%ED%9E%88%EC%96%BC' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTg3NzEzM30.7mekmYlkvjQmd6mxh7YnnsbXfDdcYwU4Fr-laMLdy3I'

응답

{
  "status": "OK",
  "msg": "Schedule retrieved successfully",
  "object": {
    "id": 1,
    "scheduleElements": [
      {
        "id": 11,
        "scheduleId": 1,
        "name": "비판적사고와 토론",
        "location": "산학219",
        "dayOfWeek": "MON",
        "color": "#FFD6D6",
        "startTime": "2024-08-24T12:00:00.000+00:00",
        "endTime": "2024-08-24T15:00:00.000+00:00"
      },
      {
        "id": 12,
        "scheduleId": 1,
        "name": "컴퓨팅적사고",
        "location": "산학320",
        "dayOfWeek": "TUE",
        "color": "#FFF3D6",
        "startTime": "2024-08-24T11:00:00.000+00:00",
        "endTime": "2024-08-24T13:00:00.000+00:00"
      },
      {
        "id": 14,
        "scheduleId": 1,
        "name": "경제학원론",
        "location": "인문106",
        "dayOfWeek": "WED",
        "color": "#D6FFDA",
        "startTime": "2024-08-24T11:00:00.000+00:00",
        "endTime": "2024-08-24T13:00:00.000+00:00"
      },
      {
        "id": 15,
        "scheduleId": 1,
        "name": "서울의 역사와 문화",
        "location": "산학307",
        "dayOfWeek": "WED",
        "color": "#D6DFFF",
        "startTime": "2024-08-24T13:30:00.000+00:00",
        "endTime": "2024-08-24T15:00:00.000+00:00"
      },
      {
        "id": 16,
        "scheduleId": 1,
        "name": "기초통계학",
        "location": "인문305",
        "dayOfWeek": "THU",
        "color": "#D6F8FF",
        "startTime": "2024-08-24T13:30:00.000+00:00",
        "endTime": "2024-08-24T16:30:00.000+00:00"
      },
      {
        "id": 17,
        "scheduleId": 1,
        "name": "기업과 사회",
        "location": "상허109",
        "dayOfWeek": "FRI",
        "color": "#EAD6FF",
        "startTime": "2024-08-24T12:00:00.000+00:00",
        "endTime": "2024-08-24T15:00:00.000+00:00"
      },
      {
        "id": 33,
        "scheduleId": 1,
        "name": "경제학세미나",
        "location": "경영관 세미나실",
        "dayOfWeek": "FRI",
        "color": null,
        "startTime": "2023-06-16T13:00:00.000+00:00",
        "endTime": "2023-06-16T16:00:00.000+00:00"
      }
    ],
    "name": "김히얼",
    "userId": null
  },
  "success": true
}

3. 시간표 삭제

- 기본정보

HTTP Method	Endpoint
DELETE	/api/v1/schedule/deleteSchedule

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
name	String	삭제할 시간표 이름	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Object	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

- 예제

요청

curl -X 'DELETE' \
  'https://www.hearus-spring-be.shop:8080/api/v1/schedule/deleteSchedule' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTg3NzEzM30.7mekmYlkvjQmd6mxh7YnnsbXfDdcYwU4Fr-laMLdy3I' \
  -H 'Content-Type: application/json' \
  -d '{
"name":"김히얼의 시간표"
}'

응답

{
  "status": "OK",
  "msg": "Schedule Deleted",
  "object": null,
  "success": true
}

Schedule API - ScheduleElement

1. 스케줄 생성

- 기본정보

HTTP Method	Endpoint
POST	`/api/v1/schedule/addElement

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
scheduleDTO	ScheduleDTO	생성할 스케줄을 포함할 시간표 정보	O
scheduleElementDTO	ScheduleElement	생성할 스케줄 정보	O

ScheduleDTO

이름	타입	설명	필수
name	String	생성할 스케줄을 포함할 시간표 이름	O

ScheduleElement

이름	타입	설명	필수
id	Integer	스케줄 ID	X
scheduleId	Integer	해당 스케줄을 포함하는 시간표 ID	O
name	String	스케줄 이름	O
location	String	스케줄 진행 장소	O
dayOfWeek	String	스케줄 진행 요일	O
color	String	스케줄을 표시할 UI의 색상	O
startTime	String	스케줄 시작 시간	O
endTime	String	스케줄 종료 시간	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Object	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

- 예제

요청

curl -X 'POST' \
  'https://www.hearus-spring-be.shop:8080/api/v1/schedule/addElement' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTkyNzIzMH0.iBwrCcMA4kA1HUM87eB_jJeZNsvxeqNSzxvXPY8EtmY' \
  -H 'Content-Type: application/json' \
  -d '{
  "scheduleDTO": {
    "name": "김히얼"
  },
  "scheduleElementDTO": {
	"name": "경제학세미나",
  	"location": "경영관 세미나실",
  	"dayOfWeek": "FRI",
  	"startTime": "2023-06-16T13:00:00",
  	"endTime": "2023-06-16T16:00:00"
  }
}'

응답

{
  "status": "OK",
  "msg": "ScheduleElement Added",
  "object": {
    "id": 44,
    "scheduleId": 1,
    "name": "경제학세미나",
    "location": "경영관 세미나실",
    "dayOfWeek": "FRI",
    "color": null,
    "startTime": "2023-06-16T13:00:00.000+00:00",
    "endTime": "2023-06-16T16:00:00.000+00:00"
  },
  "success": true
}

2. 스케줄 삭제

- 기본정보

HTTP Method	Endpoint
DELETE	`/api/v1/schedule/deleteElement

- 요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${ACCESS_TOKEN} 인증 방식, 액세스 토큰으로 인증 요청	O

본문

이름	타입	설명	필수
scheduleDTO	ScheduleDTO	삭제할 스케줄을 포함할 시간표 정보	O
scheduleElementDTO	ScheduleElement	삭제할 스케줄 정보	O

ScheduleDTO

이름	타입	설명	필수
name	String	생성할 스케줄을 포함할 시간표 이름	O

ScheduleElement

이름	타입	설명	필수
id	Integer	스케줄 ID	O

- 응답

본문

이름	타입	설명	필수
status	String	Http 상태 메시지	O
msg	String	요청 특이사항에 대한 메시지	O
obj	Object	요청에 대한 적절한 데이터를 가짐. 때에 따라 null을 가질 수 있음	O
success	Boolean	요청 성공 여부	O

- 예제

요청

curl -X 'DELETE' \
  'https://www.hearus-spring-be.shop:8080/api/v1/schedule/deleteElement' \
  -H 'accept: application/hal+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3NGI2MzY0NC05NTA3LTRiNjQtOTY3MC1hZTVkMGVhOGRjMzEiLCJyb2xlIjoiVVNFUiIsImV4cCI6MTcyOTkyNzIzMH0.iBwrCcMA4kA1HUM87eB_jJeZNsvxeqNSzxvXPY8EtmY' \
  -H 'Content-Type: application/json' \
  -d '{
  "scheduleDTO": {
    "name": "김히얼"
  },
  "scheduleElementDTO": {
    "id": 34
  }
}'

응답

{
  "status": "OK",
  "msg": "ScheduleElement Deleted",
  "object": null,
  "success": true
}