API 명세서의 요청, 응답 데이터를 기술한다.

[dia312]

목적

API 명세서의 요청, 응답 데이터를 기술한다.

작업 상세 내용

• API 명세서의 요청 데이터를 기술한다
• API 명세서의 응답 데이터를 기술한다.

항공편 단일 조회 : /flights/{flightScheduleId}

• 성공시
  • status : 200
  • request :
    • query param :
      • {arrivalFlightScheduleId} - Optional
    • path variable :
      • {flightScheduleId} - required
    • body : X
  • response :
    • departureFlightSchedule
      • flightScheduleId
      • departureAirport
      • departureCity
      • departureCountry
      • arrivalAirport
      • arrivalCity
      • arrivalCountry
      • departureDateTime
      • arrivalDateTime
      • flightName
      • cost
    • arrivalFlightSchedule
      • flightScheduleId
      • departureAirport
      • departureCity
      • departureCountry
      • arrivalAirport
      • arrivalCity
      • arrivalCountry
      • departureDateTime
      • arrivalDateTime
      • flightName
      • cost

항공편 전체 조회 : /flights

• 성공시
  • status : 200
  • request :
    • query param :
      • {cabinClass} - Optional(default: economy)
      • {headCount} - Optional(default : 1)
    • path variable :
      • {departurePlace} - required
      • {arrivalPlace} - required
      • {departureDate} - required
      • {arrivalDate} - optional
    • body : X
  • response :
    • List
      • Data
        • departureFlightSchedule
          • flightScheduleId
          • departureAirport
          • arrivalAirport
          • departureDateTime
          • arrivalDateTime
          • flightName
          • cost
        • arrivalFlightSchedule
          • flightScheduleId
          • departureAirport
          • arrivalAirport
          • departureDateTime
          • arrivalDateTime
          • flightName
          • cost

항공편 예약 : /bookings/flights

• 성공시
  • status : 201(Created)
  • request :
    • query param : X
    • path variable : X
    • body :
      • flightSchedule
        • flightScheduleId
        • cabinClass
        • headCount
  • response :
    • X

항공편 예약 취소 : /bookings/flights/{bookingId}

• 성공시
  • status : 204(No Content)
  • request :
    • query param : X
    • path variable : X
    • body : X
  • response :
    • X

항공편 예약 단일 조회 : /bookings/flights/{bookingId}

• 성공시
  • status : 200
  • request :
    • query param : X
    • path variable : X
    • body : X
  • response :
    • bookingData
      • flightScheduleId
      • departureAirport
      • arrivalAirport
      • departureDateTime
      • arrivalDateTime
      • flightName
      • cost
      • booked_at

항공편 예약 전체 조회 : /bookings/flights

• 성공시
  • status : 200
  • request :
    • query param :
      • LastDate - Optional
    • path variable : X
    • body : X
  • response :
    • List
      • bookingId
      • cabinClass
      • is_paid
      • flightScheduleId
      • departureAirport
      • arrivalAirport
      • departureDateTime
      • arrivalDateTime
      • flightName
      • cost
      • booked_at

참고 사항

노션 링크 참고