Skip to content

API

Jump to bottom
지영서 edited this page Apr 7, 2022 · 8 revisions

회원가입

Request

POST /user

클라이언트의 요청 본문엔 다음 내용이 포함되어 있습니다.

  • 요청 형식: JSON
    • MIME 타입: application/json 
{
	"email": "string", (required)
	"username": "string", (required)
	"password": "string" (required)
}

Response

  • Status Code: 201 (성공적으로 생성했을 시)
  • Status Code: 401 (생성 실패시)
  • Status Code: 500 (서버 에러)

로그인

POST /user/login

클라이언트의 요청 본문엔 다음 내용이 포함되어 있습니다.

  • 요청 형식: JSON
    • MIME 타입: application/json 
{
	email: string, (required)
	password: string (required)
}

Response

  • Status Code: 200 (성공적으로 생성했을 시)
  • Status Code: 401 (생성 실패시)
  • Status Code: 500 (서버 에러)

회원소유카드 요청

GET /user/cards

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
[
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	},
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	},
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	}
]
  • Status Code: 404 (생성 실패시)
  • Status Code: 500 (서버 에러)

로그아웃

GET /user/logout

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
  • Status Code: 404 (생성 실패시)
  • Status Code: 500 (서버 에러)

회원수정

PATCH /user

클라이언트의 요청 본문엔 다음 내용이 포함되어 있습니다.

  • 요청 형식: JSON
    • MIME 타입: application/json 
{
	username: string,
	password: string
}

회원삭제

DELETE /user

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
  • Status Code: 404 (생성 실패시)
  • Status Code: 500 (서버 에러)

카드조회

GET /cards

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
[
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	},
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	},
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	},
	....
]
  • Status Code: 404 (생성 실패시)
  • Status Code: 500 (서버 에러)

카드검색

GET /card?keyword={}

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
[
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	},
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	},
	{
		"id": "integer",
		"user_id": "integer",
		"question": "string",
		"answer": "string",
		"likes":[1,2,3,4]
	},
	....
]
  • Status Code: 404 (생성 실패시)
  • Status Code: 500 (서버 에러)

카드생성

POST /card

클라이언트의 요청 본문엔 다음 내용이 포함되어 있습니다.

  • 요청 형식: JSON
    • MIME 타입: application/json 
{
	request: "string", (required)
	answer: "string" (required)
}

Response

  • Status Code: 201 (성공적으로 생성했을 시) OK
  • Status Code: 404 (생성 실패시)
  • Status Code: 500 (서버 에러)

카드 수정

PATCH /card/{card_id}

클라이언트의 요청 본문엔 다음 내용이 포함되어 있습니다.

  • 요청 형식: JSON
    • MIME 타입: application/json 
{
	request: string,
	answer: string
}

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
  • Status Code: 400 (생성 실패시)
  • Status Code: 500 (서버 에러)

카드삭제

DELETE /card/{card_id}

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
  • Status Code: 400 (생성 실패시)
  • Status Code: 500 (서버 에러)

카드공유

POST /card/{card_id}/share

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
  • Status Code: 400 (생성 실패시)
  • Status Code: 500 (서버 에러)

좋아요~

PATCH /card/{card_id}/like

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
  • Status Code: 400 (생성 실패시)
  • Status Code: 500 (서버 에러)

좋아요 삭제

DELETE /card/{card_id}/like

Response

  • Status Code: 200 (성공적으로 생성했을 시) OK
  • Status Code: 400 (생성 실패시)
  • Status Code: 500 (서버 에러)

HOME

TEAM

PLAN

Clone this wiki locally