[내일배움캠프] 1주차 과제 (맛집 관리 API 설계)

김재진·2025년 11월 26일

내일배움캠프

목록 보기

3/70

1.API 식별하기

명동교자 본점 링크에서 개발자 도구를 사용해 실제 현업 API의 요청/응답 구조를 분석해보기

분석 내용

요청 URL : https://place-api.map.kakao.com/places/panel3/10332413

요청 메서드 : GET

상태 코드 : 200 OK

원격 주소 : 211.249.247.5:443

Content Type : application/json

클라이언트는 서버에 https://place-api.map.kakao.com/ 에서 /place/panel3/10332413 에 해당하는 자료를 조회(GET)하고자 요청을 했고 서버는 해당하는 자료를 주면서 응답으로 200 OK코드를 전송했다. 해당 하는 자료는 “menu”, “visitor”,”summary”,”photos” 등의 데이터가 있다.

2.API 명세서 만들기

맛집 관리를 위한 기능인 등록, 전체 조회, 삭제 API를 각각 작성해보기

등록

Request - 요청

Method: POST.
URL: {{baseURL}}/places
Content-Type: application/json

Body:

{
  "name": "명동교자 본점",
  "address": "서울 중구 명동10길 29 1층",
  "call": "02-776-5348",
  "category": "한식",
  "rating": 5
}

Response

Status Code: 201 Created

Body:

{
  "id": {{$randomInt}},
   "name": "{{$body 'name' ''}}",
  "address": "{{$body 'address' ''}}",
  "call": "{{$body 'call' ''}}",
  "category": "{{$body 'category' ''}}",
  "rating": "{{$body 'rating' ''}}"
}

Status Code: 400 Bad Request

Body:

{
  "message": "이름은 필수 입력 값 입니다."
}

Status Code: 500 Internal Server Error

Body:

{
"message": "요청을 처리하는 중 서버에서 오류가 발생했습니다."
}

전체조회

Request - 요청

Method: GET.

URL : {{baseURL}}/places

Content-Type: application/json

Response
Status Code: 200 OK
Body:
{
  "id": 1,
  "name": "명동교자 본점",
  "address": "서울 중구 명동10길 29 1층",
  "call": "02-776-5348",
  "category": "한식",
  "rating": 5
} 
Status Code: 500 Internal Server Error
Body:
{
  "message": "요청을 처리하는 중 서버에서 오류가 발생했습니다."
}

삭제

Request - 요청

Method: DELETE.

URL : {{baseURL}}/places/{id}

Path Parameters:

키 값
id 숫자

Content-Type: application/json

Response
Status Code: 204 No Content
Status Code: 404 Not Found
{
  "message": "해당 상품이 존재하지 않습니다."
}
Status Code: 500 Internal Server Error
Body:
{
  "message": "요청을 처리하는 중 서버에서 오류가 발생했습니다."
}