임포트 API 및 업로드 API 설정

필수 스크립트

임포트 기능을 사용하려면 필수 스크립트를 포함해야 합니다.


업로드 및 임포트 API를 구성하려면 editor.import.api, editor.upload.image.api, editor.upload.video.api, editor.upload.file.api 키를 사용합니다.

서버 측 API(URL)는 백엔드 구현에 따라 변경되어야 합니다. 자세한 내용은 서버 연동 매뉴얼을 참고합니다.

구성

키설명
editor.import.maxSize임포트 파일의 최대 크기를 설정합니다. (단위: byte, 기본값: 10 MB)이 크기는 브라우저(클라이언트)에서 설정되며, 서버 설정에 따라 임포트 가능한 파일 크기가 달라질 수 있습니다.
editor.import.api임포트 API(URL)를 설정합니다. 문서 파일이 이 API(URL)로 전송됩니다.
editor.import.param임포트 요청과 함께 전송할 매개변수를 설정합니다.
editor.import.headers2.7.0 버전부터 지원합니다. 임포트 요청 헤더를 설정합니다.
editor.import.requestOptions3.2.2507 버전부터 지원합니다. 임포트 요청에 사용할 요청 옵션을 설정합니다. 아래 Request Options를 참고합니다.
editor.upload.maxSize업로드 파일의 최대 크기를 설정합니다. (단위: byte, 기본값: 3 MB)이 크기는 브라우저(클라이언트)에서 설정되며, 서버 설정에 따라 업로드 가능한 파일 크기가 달라질 수 있습니다.
editor.upload.image.api이미지 업로드 API(URL)를 설정합니다. 이미지는 이 API(URL)로 전송됩니다.
editor.upload.image.param이미지 업로드 요청과 함께 전송할 매개변수를 설정합니다.
editor.upload.image.headers2.7.0 버전부터 지원합니다. 이미지 업로드 요청 헤더를 설정합니다.
editor.upload.image.requestOptions3.2.2507 버전부터 지원합니다. 이미지 업로드 요청에 사용할 요청 옵션을 설정합니다. 아래 Request Options를 참고합니다.
editor.upload.video.api비디오 업로드 API(URL)를 설정합니다. 비디오는 이 API(URL)로 전송됩니다.
editor.upload.video.param비디오 업로드 요청과 함께 전송할 매개변수를 설정합니다.
editor.upload.video.headers2.7.0 버전부터 지원합니다. 비디오 업로드 요청 헤더를 설정합니다.
editor.upload.video.requestOptions3.2.2507 버전부터 지원합니다. 비디오 업로드 요청에 사용할 요청 옵션을 설정합니다. 아래 Request Options를 참고합니다.
editor.upload.file.api파일 업로드 API(URL)를 설정합니다. 파일은 이 API(URL)로 전송됩니다.
editor.upload.file.param파일 업로드 요청과 함께 전송할 매개변수를 설정합니다.
editor.upload.file.headers2.7.0 버전부터 지원합니다. 파일 업로드 요청 헤더를 설정합니다.
editor.upload.file.requestOptions3.2.2507 버전부터 지원합니다. 파일 업로드 요청에 사용할 요청 옵션을 설정합니다. 아래 Request Options를 참고합니다.

요청 옵션

3.2.2507 버전부터 지원합니다.

editor.import.requestOptions, editor.upload.image.requestOptions, editor.upload.video.requestOptions, 그리고 editor.upload.file.requestOptions 키는 다음 옵션을 허용합니다.

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

구성 예시

// synapeditor.config.js
{
    'editor.import.maxSize': 10485760,
    'editor.import.api': '/importDoc.do',
    'editor.import.param': {},
    'editor.import.headers': {},
    'editor.import.requestOptions': {credentials: true, timeout: 300},
    'editor.upload.maxSize': 3145728,
    'editor.upload.image.api': '/uploadImage.do',
    'editor.upload.image.param': {},
    'editor.upload.image.headers': {},
    'editor.upload.image.requestOptions': {credentials: true, timeout: 300},
    'editor.upload.video.api': '/uploadVideo.do',
    'editor.upload.video.param': {},
    'editor.upload.video.headers': {},
    'editor.upload.video.requestOptions': {credentials: true, timeout: 300},
    'editor.upload.file.api': '/uploadFile.do',
    'editor.upload.file.param': {},
    'editor.upload.file.headers': {},
    'editor.upload.file.requestOptions': {credentials: true, timeout: 300}
}

관련 정보