Home

🚌 COMBUS Backend API

✅공통 요청/응답 형식

1. 요청 데이터 형식: json 등
2. 응답 성공, 실패 여부: success 필드에서 성공 실패 설명/상태 코드를 통해 제공

✅공통 에러

만약 API 간 공통되는 에러 코드가 존재한다면, 문서의 한 섹션에 에러 코드를 모아두고 관리를 하는 것이 효율적입니다. 문서의 한 섹션에 공통 에러를 제공하면 각 API에 에러 코드를 각각 추가하지 않아도 되고, 변경도 한 곳에만 하면 되니 테크니컬라이터 입장에서는 문서 정합성 유지에도 큰 도움이 됩니다.

✅가이드

• 사전 작업
  • 시작 가이드에는 사전에 인증키(App key)를 어떻게 발급할 수 있고 어떤 용도로 사용되는지 상세히 설명되어야 합니다.
• API 사용 시퀀스
  • API 사용 시퀀스가 존재한다면 넘버링 형식으로 시퀀스를 정리하는 것이 좋습니다.

✅API 리스트업

API종류	API명	Method	URL	설명	완료
장애인	로그인	POST	/users/login	지급 받은 회원 번호로 로그인	✅
	홈화면	GET	/users/home	예약 내역 존재시 예약 내역 출력 / 없으면 null	✅
	버스 번호 확인용 웹캠			시각 장애인용 버스 번호 확인 웹캠
	예약1: 승차 정류소 검색	POST	/users/reservation/board	직접 검색 / 혹은 음성 입출력
	예약2: 버스 검색	POST	/users/reservation/board/bus	직접 검색 / 혹은 음성 입출력
	예약3: 하차 정류소 검색	POST	/users/reservation/board/bus/drop	직접 검색 / 혹은 음성 입출력
버스 기사	로그인	POST	/drivers/login	지급 받은 회원 번호로 로그인	✅
	홈화면			승차 중, 하차 예정 승객 정보 출력
	탑승 중 승객 정보			탑승 중인 승객의 하차 정보
	탑승 예정 승객 정보			탑승 예정인 승객의 승차 정류소 및 특이 사항
	다음 정류소 알림			다음 정류소 특이사항 알림

✅참고

• 카카오엔터프라이즈 기술블로그 Tech&(테크앤):티스토리
• kakao i 기술문서