API 기본
HTTP 엔드포인트를 정의하고 요청 보내기
3 min read
Layerz 앱은 실제 서버와 통신할 수 있습니다. API 는 앱이 인터넷에서 데이터를 가져오거나 보내는 통로입니다.
대부분의 경우 OpenAPI / Swagger 가져오기로 API 를 자동 생성하는 것이 가장 빠르지만, 직접 엔드포인트를 정의할 수도 있습니다.
엔드포인트 구성
하나의 API 는 하나의 HTTP 요청을 나타냅니다.
- HTTP 메서드 —
GET,POST,PUT,DELETE,PATCH. 본문(body)은 POST/PUT/PATCH 에서 전송됩니다. - URL — 요청을 보낼 주소
- 헤더(Headers) — 함께 보낼 헤더
- 본문(Body) — 보낼 데이터
- 인증(Auth) — 인증 방식 (인증·재시도·타임아웃 참고)
API Collection
여러 API 는 API Collection 으로 묶어 관리합니다. Collection 은 서버 주소(base URL)를 공유하므로, 각 API 는 전체 주소 대신 상대 경로만 가지면 됩니다. 실제 요청 주소는 base URL + 경로 로 만들어집니다.
동적인 값 넣기
URL·헤더·본문·인증값에는 바인딩 토큰({Parameters.…}, {Project.…})을 넣어 요청 시점에 실제 값으로 채울 수 있습니다.
요청 보내기
설정한 API 는 Action Flow 의 API Call 액션으로 호출합니다. 응답을 화면에 연결하는 방법은 API 응답을 화면에 바인딩하기에서 다룹니다.
처음이라면 직접 만들기보다 공개 API 의 OpenAPI 문서를 가져오기로 시작하는 것을 권합니다. 엔드포인트와 응답 구조가 한 번에 준비됩니다.