API 명세

소개

https://github.com/prgrms-fe-devcourse/NFE1-1-8-MOODI NFE1-1-8-MOODI에서 사용할 API 문서 입니다.

기본 URL: 모든 Api 요청은 https://td3axvf8x7.execute-api.ap-northeast-2.amazonaws.com/moodi을 기반으로 합니다.

테스트 URL

postman url

Diary Api

기본 URL: API 요청은https://td3axvf8x7.execute-api.ap-northeast-2.amazonaws.com/moodi/diray을 바탕으로 진행합니다.

인증

• 위 api는 jwt 토큰을 이용한 인증 방식이 필요합니다
  • type : Bearer Token

HTTP 메서드 사용

• GET: 일기를 조회합니다.
  • query parameters
    • page: 페이지 번호 (기본값: 1)
    • limit: 페이지당 항목 수 (기본값: 12, 최대값: 42)
    • user_email: 작성자 email 기반으로 가져옵니다(기본값 : all)
    • is_public: 공개 여부 필터링 (기본값 전체, 1일시 공개 데이터만 가져오기, 0일시 비공개 데이터만 가져오기)
    • sort_by: 정렬 기준 (기본 값 : 등록된 순, lastest 입력시 최신순으로 가져옵니다.)
    • month : 해당 일기가 작성된 달을 기준으로 가져옵니다.
    • year: 해당 일기가 작성된 년을 기준으로 가져옵니다.
    • week : 해당 일기를 작성된 주를 기준으로 가져옵니다.
• POST: 일기를 작성합니다.
  • body parameters
    • title (string, 필수): 일기의 제목
    • content (string, 필수): 일기의 내용
    • date (string, 필수): 일기의 주제 날짜 시간. 형식은 YYYY-MM-DD HH:MM:SS이어야 합니다.
    • is_public (boolean, 필수): 일기의 공개 여부 (true 또는 false)
    • music_url (string, 필수): 일기와 관련된 음악의 URL
    • author_email (string, 필수): 작성자의 이메일 주소
    • mood (string, 필수): 일기 작성 시의 기분
    • sub_emotion (object, 선택) : 서브 감정 작성합니다.
    • emotion (string, 필수): 일기 작성 시의 감정
    • music_title (string, 필수): 음악의 제목
    • music_imgurl(string, 필수): 음악의 썸네일 주소
    • music_id(string, 필수): 음악의 아이디
    • artist(string, 필수): 가수
• PATCH : 특정 일기를 업데이트 할 시 사용합니다.
  • body parameters
    • id (integer, 필수): 수정할 일기의 고유 ID
    • title (string, 선택): 일기의 제목
    • content (string, 선택): 일기의 내용
    • is_public (boolean, 선택): 일기의 공개 여부 (true 또는 false)
    • music_url (string, 선택): 일기와 관련된 음악의 URL
    • mood (string, 선택): 일기 작성 시의 기분
    • emotion (string, 선택): 일기 작성 시의 감정
    • author_email (string, 선택): 작성자의 이메일 주소
    • music_title (string, 선택): 음악의 제목
    • music_imgurl(string, 선택): 음악의 썸네일 주소
    • music_id(string, 선택): 음악의 아이디
    • artist(string, 선택): 가수
• DELETE: 일기 데이터를 삭제합니다.
  • query parameters
    • id : 삭제할 일기의 id
• GET/id : 상세 일기를 조회합니다.
  • path parameters
    • id(number, 선택) : 불러올 일기의 id입니다.

JSON CONVENTIONS

• 모든 속성 이름은 snake_case 형식을 사용합니다. 즉, 단어는 소문자로 작성되며, 단어 사이에 언더스코어(_)로 구분됩니다. 예를 들어, camelCase나 kebab-case 형식은 사용하지 않습니다.
• 시간 값은YYYY-MM-DD HH:MM:SS형식 사용

에러코드

에러 응답에는 code 와 message가 포함됩니다.

reaction Api

기본 URL: API 요청은 https://td3axvf8x7.execute-api.ap-northeast-2.amazonaws.com/moodi/reaction을 바탕으로 진행합니다.

인증

• 위 api는 jwt 토큰을 이용한 인증 방식이 필요합니다
  • type : Bearer Token

HTTP 메서드 사용

• POST: 일기를 작성합니다.
  • body parameters
• DELETE: 일기 데이터를 삭제합니다.

JSON CONVENTIONS

• 모든 속성 이름은 snake_case 형식을 사용합니다. 즉, 단어는 소문자로 작성되며, 단어 사이에 언더스코어(_)로 구분됩니다. 예를 들어, camelCase나 kebab-case 형식은 사용하지 않습니다.
• 시간 값은YYYY-MM-DD HH:MM:SS형식 사용

에러코드

에러 응답에는 code 와 message가 포함됩니다.

| --- | --- | --- |

auth api

로그인 URL: API 요청은 [https://td3axvf8x7.execute-api.ap-northeast-2.amazonaws.com/moodi/](<https://td3axvf8x7.execute-api.ap-northeast-2.amazonaws.com/moodi/diray>)login을 바탕으로 진행합니다.

회원가입 URL: API 요청은 [https://td3axvf8x7.execute-api.ap-northeast-2.amazonaws.com/moodi/](<https://td3axvf8x7.execute-api.ap-northeast-2.amazonaws.com/moodi/diray>)signup을 바탕으로 진행합니다.

인증 URL : **** API 요청은 https://td3axvf8x7.execute-api.ap-northeast-2.amazonaws.com/moodi/verify을 바탕으로 진행합니다.

토큰 발급

• 위 API는 토큰을 발급합니다. 꼭 발급 받은 토큰을 LocalStorage에 저장해주세요!

HTTP 메서드 사용