HTTP API SPEC ( API 명세서 )

Last Update : 2021-03-18

 

www.notion.so/API-1498b7b706ad4a5284fbc9567a8184be 에서 복사해와서 맛대로 변경한 데이터.

Basic

  PORT : 8088

Dynamic URI

• Dynamic URI는 동적 URI로, Path(경로)에 원하는 값을 설정할 수 있는 URI를 말함
• Ex)
  • Dynamic URI → http://localhost:80/v1/students/uuid/{student_uuid}
  • 기능 → student_uuid 부분에 명시된 특정 학생의 정보를 조회해오는 API
  • {student_uuid}부분에 클라이언트가 조회를 원하는 학생의 리소스 UUID를 지정할 수 있다.
  • student-111111111111의 학생 정보 조회 → /students/uuid/student-111111111111
• 이러한 URI의 {} 안에 있는 것들을 경로 변수(Path Variable)이라고 칭함

How to Authenticate?

• Set Authorization(Key) in Request Header (형식 → "Bearer ${access_token}")

About Content-Type

• Content-Type은 통신을 할 때 Request Body에 어떤 형식으로 값을 설정하고 읽을 것인지를 명시한 것임
• 일반적으로 대부분의 API가 지원하는 Content-Type은 application/json 임
• 하지만 미디어 파일(사진, 동영상 등)을 전달 받는 API는 multipart/form-data를 Content-Type로 사용함

HTTP API SPEC

계정 및 사용자 정보 API

GET LIST

 /api/v1/user : 로그인 유저 조회

 /api/v1/userList  : 유저목록 (관리자)

 /api/v1/user/{id}  : 특정 사용자 정보 조회

 

POST LIST

 /api/v1/login : 로그인 - 성공 200 실패 400 

 /api/v1/join : 회원가입 - 성공 201 실패 400 (중복여부 포함)

 

PUT LIST

 /api/v1/user : 회원 정보 수정 

 

식당 정보 API

 

GET LIST

 /api/v1/shop/{id} : 식당 정보

 /api/v1/shopIntro : 식당 소개

 /api/v1/myShop : 식당 보유 유저 -> 내 식당 조회

 /api/v1/shopList : 식당목록

 

POST LIST

 /api/v1/shop : 매장 등록 - 성공 201 실패 400

 

메뉴 정보 API

 

GET LIST

 /api/v1/menuList/{shopId} : 특정 식당 메뉴리스트 조회

 /api/v1/menu/{menuId} : 식당 소개

 

POST LIST

 /api/v1/menu : 메뉴 등록 - 성공 201 실패 400 (미구현)

 

PUT LIST

 /api/v1/menu : 메뉴 정보 수정  (미구현)

 

Open API

• 네이버 지역 검색 api

 

네이버 지역 검색 API

 

GET LIST

 /api/v1/searchLocal/{keyword}: 키워드로 검색한 결과 반환