Global OTA RequestAndResponse (GOTAR)

글로벌 OTA 렌터카 API들에 대한 통합 규격을 정의 하는 Repository

APIs

글로벌 OTA 렌터카 API들에 대한 DTO Interface

• ${API Name}Request

  • ${API Name}의 요청 값에 대한 정의

• ${API Name}Response

  • ${API Name}의 응답 값에 대한 정의

Interfaces

글로벌 OTA 렌터카 API에 사용되는 Interface

• Required: 아래 정의 되는 Interface의 각 Key는 모두 필수 값 입니다.
  • 작업하는 API에서 Key에대한 Value 값을 정의할 수 없다면 아래 기본값을 사용해야 합니다. (Nullable인경우 Null)
  • 주석 내용 중 @required: true 인 경우 기본값을 넣을 수 없는 Key입니다.
  • 기본 값을 할당할 수 없는 Key는 기본 값을 상수로 만들어 할당 해야 합니다.
    • String : null or ''
    • Number : null or 0
    • Boolean : false
    • Array : [] (Empty Array)

Comment Component

• @type
  • String, Boolean등 Component들의 타입
• @description
  • Component에대한 설명
• @nullable
  • Null허용 여부
• @required
  • Interface에서 기본값 이 불가능 한 필수적 으로 정의해야 하는 값인지 에대한 여부
• @example
  • Component 예시값 (실제 값과 최대한 비슷 하게), 열거 가능한 값인 경우 열거 가능한 값을 전부 작성.
• @default
  • Component 기본값, 불가능 한 경우 N/A

Interface

• Car

  • 차종에 대한 정의 (실제 판매 되는 렌터카에 대한 차종 EX: K5등)
  • 운영에 사용되는 캐싱된 차종

• Vehicle

  • 차량에 대한 정의 (실제 판매 되는 렌터카 상품)

• Affiliate

  • 업체에 대한 정의 (운영에 사용되는 캐싱된 업체)

• Vendor

  • Budget, Avis와 같은 업체 브랜드

• Shop

  • Budget LA공항점과 같은 업체의 지점

• Order

  • Vehicle에대한 실제 주문 내용

• Reservation

  • Carmore 운영에 사용 되는 예약에 대한 Interface

APIs

Global API에서 필수적 으로 제공 해야 하는 API

• APIs Name

  • APIs Description
  • API Name
    • Request : 해당 API의 Request Query, Param, Body를 포함한 Typescript File
    • Response : 해당 API의 Response를 Typescript File
    • endPoint : 해당 API의 EndPoint 및 Http Method

• Vehicle

  • 차량 목록, 차량 상세를 제공 해야 한다.
    • 차량 목록
      • Request
      • Response
      • endPoint : GET /vehicles
    • 차량 상세
      • Request
      • Response
      • endPoint : GET /vehicles/:id

• Order

  • 예약 생성, 예약 상세, 예약 취소를 제공 해야 한다.
    • 예약 생성
      • Request
      • Response
      • endPoint : POST /orders
    • 예약 상세
      • Request
      • Response
      • endPoint : GET /orders/:id
    • 예약 취소
      • Request
      • Response
      • endPoint : PATCH /orders/:id/cancelation

• Affiliates

  • 캐싱 업체 목록 조회, 캐싱 업체 단일 조회를 제공 해야 한다.
    • 업체 목록 조회
      • Request
      • Response
      • endPoint : GET /affiliates/
    • 업체 단일 조회
      • Request
      • Response
      • endPoint : GET /affiliates/:id

• Cars

  • 캐싱 차종 목록 조회, 캐싱 차종 단일 조회를 제공 해야 한다.
    • 차종 목록 조회
      • Request
      • Response
      • endPoint : GET /cars/
    • 차종 단일 조회
      • Request
      • Response
      • endPoint : GET /cars/:id

• Reservations

  • 예약 목록에대한 정보를 제공 해야한다
    • 예약 목록 조회
      • Request
      • Response
      • endPoint : GET /reservations/

Flow

graph LR
    VendorAPI[원천API] <-->|VendorAPI Request And Response| WrappingAPI[랩핑API]
    WrappingAPI <-->|GOTAR Request And Response| CarmoreAPI[카모아API]
    CarmoreAPI -->|Carmore API Request And Response| Carmore[카모아]