| Status | ||||
|---|---|---|---|---|
|
기능설명
Export API 서버는 에디터에서 사용된 이미지를 다운로드한 뒤, 문서를 HWPX, DOCX 등 다양한 포맷으로 변환하여 파일을 반환하는 역할을 합니다.
| Note |
|---|
Export API Docker 이미지는 담당 영업사원을 통해 요청해 주시기 바랍니다. |
실행환경
본 Export API 실행 모듈은 Docker 컨테이너 환경에서 실행됩니다.
Docker가 설치 및 실행 가능한 Linux 운영체제에서 사용 가능합니다.
다음은 검증된 환경 예시입니다.
Ubuntu 18.04 이상
CentOS 7 이상 / RHEL 7 이상
Debian 9 이상
Fedora 30 이상
컨테이너 내부 실행 환경은 node:18-slim 이미지를 기반으로 하며,
호스트 운영체제에 따른 실행 모듈의 동작 차이는 없습니다.
실행 방법
| Code Block | ||
|---|---|---|
| ||
## Installation # Load Docker image: docker load -i export_api.tar # Docker run docker run -d --name export-api \ -p 9090:9090 \ -e REMOTE_SOURCE_PROXY_DOMAINS=example.com,.internal.local \ -e REMOTE_SOURCE_PROXY_TARGET=http://10.0.0.5:8080/remote/ \ export-api:latest |
옵션 설명
- `PORT`: 서버 리스닝 포트 (기본값 9090)
- `REMOTE| 옵션명 | 설명 | 기본값 | 필수 여부 | 예시 |
|---|---|---|---|---|
PORT | 서버가 리스닝하는 포트 번호 | 9090 | 필수 | PORT=9090 |
REMOTE_SOURCE_PROXY_ |
DOMAINS | 원격 이미지 |
| 프록시를 적용할 도메인 목록 ( |
| 쉼표로 구분) | 없음 | 선택 | example.com,.internal. |
local |
REMOTE_SOURCE_PROXY_ |
TARGET | 내부망에서 접근 가능한 프록시 대상 베이스 URL |
서버 상태 check
에디터 툴바설정에 'export'추가시 내보내기 다이얼로그를 사용할 수 있습니다.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
'editor.toolbar': [..., 'export', ...]
} |
익스포트 UI 다이얼로그
파일 포맷을 지정합니다.
다른 포맷(hwp, doc, docx 등)으로 저장이 필요한 경우 고객문의
용지 방향을 설정합니다.
A4 세로(defalut)
A4 가로
저장할 파일명을 입력합니다.
문자열
(미입력 시: untitled)
내보내기 시 생성된 파일은 사용 중인 브라우저의 기본 다운로드 경로에 저장됩니다.
'editor.export.extensions' 키를 사용해 임포트 가능한 문서 확장자를 설정할 수 있습니다.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ // TODO 작업해야함
'editor.export.extensions' : ['HWPX']
} |
API
| Endpoint | Method | 설명 |
|---|---|---|
| /exportFile | POST | 웹 에디터가에서 직렬화한 문서(serializedData)와 이미지 리소스를 통해 특정 포맷의 문서로 반환합니다. |
| /info | GET | 배포된 서버 정보(프로덕트 이름, 버전, Exporter 버전 등)를 조회합니다. |
| /health | GET | 서버가 정상 기동 중인지 확인하는 헬스 체크. { "status": "ok" }을 반환합니다. |