API 문서

Seunghee Ryu·2023년 10월 21일
0

핀테크 클론코딩

목록 보기
3/5

본 API 문서에는 다음과 같은 항목을 기록한다.

  • ID: 여러 API 항목들을 구별하는 ID
  • URL: 요청 경로
  • Method : request 방식
  • Description: 간단한 설명
  • Request Payload: 클라이언트가 요청 시 보내는 데이터
  • Response Data: 서버가 응답으로 보내는 데이터

Type Define Sheet

NameDescriptionItem
Example1Example2Example3

User

  1. 로그인
IDURLMethodDescriptionRequest PayloadResponse Data
login------유저의 아이디와 비밀번호를 확인하는 로그인 페이지로 이동한다.------
  1. 메인
IDURLMethodDescriptionRequest PayloadResponse Data
main------유저의 계좌 잔액과 조회, 송금(이체) 버튼이 있는 메인 페이지로 이동한다.------
  1. 계좌상세
IDURLMethodDescriptionRequest PayloadResponse Data
account------유저의 계좌 상세 페이지로 이동한다.------
  1. 계좌거래내역조회
IDURLMethodDescriptionRequest PayloadResponse Data
accountHistory------유저의 계좌 잔액과 송금(이체) 버튼이 있는 계좌 거래 내역 페이지로 이동한다------
  1. 송금(이체)
IDURLMethodDescriptionRequest PayloadResponse Data
remittance------송금(이체)할 대상 계좌 입력칸과 송금(이체) 금액을 기입하는 칸이 있는 페이지로 이동한다------

0개의 댓글