📑
Sansam API
  • 📑산삼펫 API
Powered by GitBook
On this page
  • 회원 가입 / 로그인 API
  • 회원 가입 API
  • 로그인 API
  • 산삼 시터 조회 API
  • 산삼 시터 전체 조회 API
  • 산삼 시터 개인 조회 API
  • 예약 CRUD API
  • 예약 작성 API
  • 예약 전체 조회 API
  • 예약 수정 API
  • 예약 삭제 API
  • 리뷰 CRUD API
  • 리뷰 작성 API
  • 리뷰 전체 조회 API
  • 리뷰 수정 API
  • 리뷰 삭제 API

산삼펫 API

회원 가입 / 로그인 API

회원 가입 API

POST localhost:3000/api/signup

Request Body

Name
Type
Description

nickname*

string

user nickname

password*

string

password for user nickname

{
message:"회원 가입에 성공하였습니다."
}
{
message:"중복된 닉네임입니다."
}
{
message:"닉네임은 최소 3자 이상, 알파벳 대소문자(a~z, A~Z), 숫자(0~9)로 구성해 주세요."
}
{
message:"비밀번호는 최소 4자 이상입니다."
}
{
message:"비밀번호와 비밀번호 확인이 일치하지 않습니다."
}
{
message:"미입력된 항목이 있습니다. 모두 입력하여 주세요."
}

로그인 API

POST localhost:3000/api/login

Request Body

Name
Type
Description

nickname*

String

user nickname

password*

String

password for user nickname

{
message:"로그인에 성공하였습니다."
}
{
message:"로그인에 실패하였습니다."
}

산삼 시터 조회 API

산삼 시터 전체 조회 API

GET localhost:3000/api/petsitters

{
    message:"산삼 시터 전체 조회에 실패하였습니다."
}
{
    petsitters
}

산삼 시터 개인 조회 API

GET localhost:3000/api/petsitters/:petsitterId

{
petsitter
}
{
message:"산삼 시터 개인 조회에 실패하였습니다."
}

예약 CRUD API

예약 작성 API

POST localhost:3000/api/reservations

Parmerter : user (req.locals.user)

Request Body

Name
Type
Description

reservationAt*

datetime

datetime of reservation

petsitter_id *

String

petsitter_id of reservation

{
    message:"예약에 성공하였습니다."
}
{
    message:"예약에 실패하였습니다."
}

예약 전체 조회 API

GET localhost:3000/api/reservations

Parmerter : user (req.locals.user)

{ reservations }
{
    message:"예약이 없습니다. 첫 예약을 진행해 주세요."
}
{
    message:"예약 조회에 실패하였습니다."
}

예약 수정 API

PATCH localhost:3000/api/reservations

Parmerter : user (req.locals.user)

Parmerter : reservationId (req.query)

Request Body

Name
Type
Description

reservationAt*

datetime

reservation date

petsitter_id*

String

petsitter_id of reservation

{
    message:"예약 수정에 성공하였습니다."
}
{
    message:"예약 수정에 실패하였습니다."
}

예약 삭제 API

DELETE localhost:3000/api/reservations

Parmerter : user (req.locals.user)

Parmerter : reservationId (req.query)

{
    message:"예약 삭제에 성공하였습니다."
}
{
    message:"예약 삭제에 실패하였습니다."
}

리뷰 CRUD API

리뷰 작성 API

POST localhost:3000/api/petsitters/:petsitterId/review

Parmerter : user (req.locals.user)

Parmerter : petsitterId (req.params)

Request Body

Name
Type
Description

content*

string

content of the review

star*

int

star of the review

{
    message:"리뷰 작성에 성공하였습니다."
}
{
    message:"리뷰 작성에 실패하였습니다."
}

리뷰 전체 조회 API

GET localhost:3000/api/petsitters/:petsitterId/reviews

Parmerter : user (req.locals.user)

Parmerter : petsitterId (req.params)

{
    reviews
}
{
    message:"리뷰가 없습니다. 첫 작성자가 되어 주세요."
}
{
    message:"리뷰 조회에 실패하였습니다."
}

리뷰 수정 API

PATCH localhost:3000/api/petsitters/:petsitterId/review

Parmerter : user (req.locals.user)

Parmerter : petsitterId (req.params)

Parmeter : reviewId(req.query)

Request Body

Name
Type
Description

content*

String

content of the comment

{
    message:"리뷰 수정에 성공하였습니다."
}
{
    message:"리뷰 수정에 실패하였습니다."
}

리뷰 삭제 API

DELETE localhost:3000/api/petsitters/:petsitterId/review

Parmerter : user (req.locals.user)

Parmerter : petsitterId (req.params)

Parmeter : reviewId(req.query)

{
    message:"리뷰 삭제에 성공하였습니다."
}
{
    message:"리뷰 삭제에 실패하였습니다."
}

Last updated 1 year ago

📑