API 명세

Dango APIs

ingredient - 원재료 관련 API

GET - /api/ingredient/search?pageable={pageable}

• 모든 원재료의 정보를 리스트로 반환합니다.
• pageable을 쿼리스트링으로 받습니다.
• pageable

{
  "page": 0,
  "size": 1,
  "sort": [
    "string"
  ]
}

GET - /api/ingredient/search/type/{keyword}?pageable={pagealbe}

• 타입(원재료의 카테고리) 기준으로 원재료의 정보를 반환합니다.
• keyword가 포함되어 있으면 모두 반환합니다.
• path variables
  • keyword : 검색할 원재료의 타입(카테고리)

GET - /api/ingredient/search/name/{keyword}?pageable={pagealbe}

• 이름 기준으로 원재료의 정보를 반환합니다.
• keyword가 포함되어 있으면 모두 반환합니다.
• path variables
  • keyword : 검색할 원재료의 이름

log - 냉장고 안 물품 관련 API

GET - /api/log/{id}

• 냉장고 안 개별 물품의 상세 정보를 조회합니다.
• id를 기준으로 상세 사항(물품정보 + 물품이 속한 원재료의 정보)을 반환합니다.
• path variables
  • id : 조회할 물품의 id

POST - /api/log

• 냉장고 안 개별 물품을 추가합니다.
• registerDTO에 맞게 요청해야 합니다.

{
  "refrigeratorId": 0,
  "name": "string",
  "category": "string",
  "type": 0
}

PUT - /api/log

• 냉장고 안 개별 물품을 수정합니다.
• editDTO에 맞게 요청해야 합니다.
• 도착한 값에 대해서만 업데이트하고, 나머지 컬럼은 수정하지 않습니다.

{
  "id": 0,
  "name": "string",
  "category": "string",
  "expirationTime": "2024-04-07T14:41:54.160Z",
  "inputTime": "2024-04-07T14:41:54.160Z",
  "outputTime": "2024-04-07T14:41:54.160Z",
  "type": 0,
  "exist": true
}

DELETE - /api/log/{id}

• 냉장고 안 개별 물품을 삭제합니다.
• id 기준으로 물품을 삭제합니다.
• path variables
  • id : 삭제할 물품의 id

refrigerator - 냉장고 관련 API

GET - /api/refrigerator

• 내 냉장고를 조회합니다.
• 토큰을 기준으로 유저를 조회하고, 유저에게 속한 '냉장고'를 리턴합니다.

GET - /api/refrigerator/{refrigeratorNickname}

• 냉장고 안에 들어있는 품목을 리스트로 조회합니다
• 냉장고 안 물품 중 '냉장고(닉네임)'에 속한 모든 물품을 조회합니다.
• 토큰으로 조회한 유저에게 속한 냉장고만 조회할 수 있습니다.
• path variables
  • refrigeratorNickname : 조회할 냉장고의 별명

GET - /api/refrigerator/{refrigeratorNickname}/door

• 냉장고가 열려있는지 조회합니다.
• path variables
  • refrigeratorNickname : 조회할 냉장고의 별명

GET - /api/refrigerator/old/{refrigeratorNickname}?t={t}

• 냉장고 안의 품목 중 오래된 것들을 조회합니다.
• 조회 기준 날짜 t를 쿼리스트링으로 받습니다. 전달되지 않으면 기본 10일이 적용됩니다.
• path variables
  • refrigeratorNickname : 조회할 냉장고의 별명

POST - /api/refrigerator

• 내 냉장고를 등록합니다.
• 토큰으로 유저를 조회하고, 그 유저에게 냉장고를 등록합니다.
• request body -> text/plain

String

PUT - /api/refrigerator

• 내 냉장고를 수정합니다.
• 토큰으로 유저를 조회하고, 그 유저에게 속한 냉장고가 있으면 수정합니다.
• request body로 전잘 된 냉장고가 이미 존재하는 냉장고인 경우 그 냉장고로 수정되며, 없는 냉장고인 경우 냉장고가 DB에 새로 등록됩니다.
• request body -> text/plain

String

GET - /api/user/profile

유저조회

• 유저 데이터를 조회합니다.
• 토큰으로 유저 정보를 가져와 조회합니다
• 토큰을 제출하지 않으면 403 에러를 반환합니다
• request header -> Authorization (AccessToken)

POST - /api/users/login

로그인

• 로그인을 시도합니다
• 유저네임은 이메일 형태를 가져야합니다.
• 비밀번호는 비밀번호는 최소 8자, 최소 하나의 문자 및 하나의 숫자를 포함해야합니다.

request body -> application/json

{
  "username": "string",
  "password": "string"
}

reseponse body -> application/json

{
  "status": 0,
  "message": "string",
  "data": {
    "nickname": "string",
    "email": "string",
    "refrigeratorNickname": "string",
    "accessToken": "string",
    "refreshToken": "string"
  }
}

GET - /api/users/logout

로그아웃

• 두개의 토큰을 헤더로 제출합니다
• 서비스로직에서 토큰을 검증하고 블랙리스트 설정을 하여 로그아웃 처리를 합니다

Request Header

++ Authorization (String) ++ Refresh-Token (String)

Response Body -> application/json

{
  "status": 0,
  "message": "string",
  "data": "string"
}

GET - /api/users/check

중복검사

• 이메일과 닉네임을 입력받아 중복검사를 합니다
• 두가지 파라미터 모두 입력할 필요는 없습니다

Request Required

• email (String)
• nickname (String)

Response Body -> application/json

{
  "status": 0,
  "message": "string",
  "data": "string"
}

GET - /api/users/register/profile

회원가입

• 이메일 / 비밀번호 / 닉네임을 입력합니다
• 이메일 중복검사를 서비스 로직에서 처리합니다.
• 닉네임 중복검사를 서비스 로직에서 처리합니다.

Request Required

• username (String)
• password (String)
• nickname (String)

Response Body -> application/json

{
  "status": 0,
  "message": "string",
  "data": "string"
}