사용자 지정 엔드포인트 정의

엔드포인트 정의는 사용할 함수 또는 액션과 HTTP 요청 사이의 매핑입니다. 엔드포인트 집합을 먼저 만들고 기반 함수/액션의 매개변수 및 동작을 확인합니다.

기반 함수 또는 액션 선택

집합의 Configuration에서 Custom endpoints 표 오른쪽 위의 + New endpoint를 선택합니다.

Configuration에서 사용자 지정 엔드포인트를 추가하는 위치

Create a custom endpoint에서 엔드포인트 이름과 실행할 기반 액션 또는 함수를 선택합니다.

엔드포인트 이름과 온톨로지 함수 또는 액션 선택

기반 작업의 각 매개변수를 엔드포인트 매개변수에 연결합니다.

구성	지원 범위
HTTP 메서드	GET, POST, PUT, DELETE, PATCH
경로	서브도메인 아래의 사용자 지정 경로와 path parameter
Query parameter	추가 입력을 URL query로 받아 함수 매개변수에 전달
Header parameter	요청 헤더를 함수 입력에 연결
Request body	POST, PUT, PATCH와 DELETE의 사용자 지정 본문 구조

가상 경로 /form/{formId}/section/{sectionId}처럼 기존 조직의 URL 형식에 맞출 수 있습니다. 경로에 나타나는 이름과 기반 함수/액션의 입력 이름을 각각 매핑합니다.

기반 작업의 입력을 요청 경로, query, header 또는 body에 연결하는 화면

선택 매개변수까지 포함하여 모든 매개변수의 매핑을 정의해야 합니다. 이는 설정에서 대응 관계를 빠짐없이 지정하라는 조건이며, 기반 작업의 모든 선택 입력을 각 요청에서 필수로 보내라는 뜻은 아닙니다.

일부 JSON 입력은 requestBody에만 매핑할 수 있습니다. 이런 입력이 있다면 본문을 지원하는 메서드를 선택하고 본문 구조로 연결합니다.

Create Endpoint를 선택하면 정의를 저장합니다.

입력 매핑을 저장한 사용자 지정 엔드포인트 정의

새 정의를 저장하는 것만으로 외부 호출이 가능해지지는 않습니다. 릴리스를 게시하고 배포해야 승인한 도메인에서 접근할 수 있습니다.

기반 작업이 액션이면 요청이 온톨로지 데이터를 변경할 수 있습니다. HTTP 메서드 이름만으로 업무 부작용을 판단하지 말고 선택한 함수/액션의 동작을 확인합니다.