내보내기 API 설정

3.3.2602 버전부터 지원합니다.

editor.export.api 키를 사용하여 내보내기 API 엔드포인트를 설정합니다.

URL은 백엔드 환경에 따라 자유롭게 설정할 수 있습니다.

기본 내보내기 API 서버(Docker 이미지 또는 Node 서버)에 직접 연결하여 사용할 수 있으며, 필요에 따라 프록시 서버를 거쳐 별도의 API 엔드포인트를 사용하도록 구성할 수도 있습니다.

내보내기 API 서버 구성 및 실행 방법에 대한 자세한 내용은 내보내기 API 서버 매뉴얼을 참고합니다.

구성

키설명
editor.export.api내보내기 API(URL)를 설정합니다. 문서 파일이 이 API(URL)로 전송됩니다.
editor.export.param내보내기 요청과 함께 전송할 매개변수를 설정합니다.
editor.export.headers내보내기 요청 헤더를 설정합니다.
editor.export.requestOptions내보내기 요청에 사용할 요청 옵션을 설정합니다. 아래의 editor.export.requestOptions를 참고합니다.

editor.export.requestOptions

내보내기 요청에 사용할 요청 옵션을 설정합니다.

키타입설명
credentialsboolean다른 도메인으로 AJAX 요청을 보낼 때 인증 정보(쿠키, 인증 헤더 등)를 포함할지 지정합니다.
timeoutnumber요청에 대한 응답 대기 시간을 밀리초(ms)로 설정합니다.

구성 예시

// synapeditor.config.js
{
    'editor.export.api': '/exportFile',
    'editor.export.param': {},
    'editor.export.headers': {},
    'editor.export.requestOptions': {credentials: true, timeout: 300},
}

관련 정보