#REST API 데이터 소스

#소개

이 플러그인은 REST API 소스의 데이터를 원활하게 통합할 수 있도록 도와줍니다.

#설치

이 플러그인은 상업용 플러그인이므로, 플러그인 관리자를 통해 업로드하고 활성화해야 합니다.

#REST API 데이터 소스 추가

플러그인을 활성화한 후, 데이터 소스 관리의 '새로 추가(Add new)' 드롭다운 메뉴에서 'REST API'를 선택합니다.

REST API 데이터 소스를 설정합니다.

#컬렉션 추가

NocoBase에서 RESTful 리소스는 컬렉션으로 매핑됩니다. 예를 들어, Users 리소스는 다음과 같습니다.

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

이러한 API 엔드포인트는 NocoBase API에서 다음과 같이 설정됩니다.

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

NocoBase API 설계 사양에 대한 자세한 내용은 API 문서를 참조하십시오.

"NocoBase API - Core" 챕터를 확인하십시오.

REST API 데이터 소스의 컬렉션 설정은 다음과 같습니다.

#List

리소스 목록을 조회하는 인터페이스를 매핑합니다.

#Get

리소스 상세 정보를 조회하는 인터페이스를 매핑합니다.

#Create

리소스를 생성하는 인터페이스를 매핑합니다.

#Update

리소스를 업데이트하는 인터페이스를 매핑합니다.

#Destroy

리소스를 삭제하는 인터페이스를 매핑합니다.

List와 Get 인터페이스는 필수로 설정해야 합니다.

#API 디버깅

#요청 파라미터 연동

예시: List 인터페이스에 페이지네이션 파라미터를 설정합니다. (만약 서드파티 API가 자체적으로 페이지네이션을 지원하지 않는다면, 가져온 목록 데이터를 기준으로 페이지네이션이 적용됩니다.)

인터페이스에 추가된 변수만 적용됩니다.

'Try it out'을 클릭하여 디버깅하고 응답 결과를 확인할 수 있습니다.

#응답 형식 변환

서드파티 API의 응답 형식이 NocoBase 표준과 다를 수 있으므로, 프런트엔드에 올바르게 표시되려면 변환이 필요합니다.

서드파티 API의 응답 형식에 따라 변환 규칙을 조정하여 NocoBase 출력 표준에 맞도록 합니다.

디버깅 프로세스 설명

#변수

REST API 데이터 소스는 API 연동을 위해 세 가지 유형의 변수를 제공합니다.

• 데이터 소스 사용자 지정 변수
• NocoBase 요청 변수
• 서드파티 응답 변수

#데이터 소스 사용자 지정 변수

#NocoBase 요청 변수

• Params: URL 쿼리 파라미터(Search Params)이며, 각 인터페이스마다 다를 수 있습니다.
• Headers: 요청 헤더로, 주로 NocoBase에서 정의한 특정 X- 정보를 제공합니다.
• Body: 요청 본문입니다.
• Token: 현재 NocoBase 요청의 API 토큰입니다.

#서드파티 응답 변수

현재는 응답 본문만 제공됩니다.

각 인터페이스 연동 시 사용 가능한 변수는 다음과 같습니다.

#List

#Get

#Create

#Update

#Destroy

#필드 설정

연동된 리소스의 CRUD 인터페이스 데이터에서 필드 메타데이터(Fields)를 추출하여 컬렉션의 필드로 사용합니다.

필드 메타데이터를 추출합니다.

필드 및 미리보기입니다.

필드를 편집합니다 (다른 데이터 소스와 유사한 방식입니다).

#REST API 데이터 소스 블록 추가

컬렉션 설정이 완료되면, 인터페이스에 블록을 추가할 수 있습니다.