| 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 이상
운영 환경에서는 Linux (x86_64 / amd64) 서버에서의 실행을 권장합니다.
해당 환경에서는 아키텍처 에뮬레이션 없이 네이티브로 실행되어 성능 및 안정성이 가장 우수합니다.
컨테이너 내부 실행 환경은 node:18-slim 이미지를 기반으로 하며,
호스트 운영체제에 따른 실행 모듈의 동작 차이는 없습니다.
macOS(Apple Silicon) 및 Windows 환경에서도 Docker Desktop을 통해 실행이 가능하나,
해당 환경에서는 아키텍처 에뮬레이션이 사용될 수 있으므로 개발 및 테스트 용도로만 사용하는 것을 권장합니다.
실행 방법
| 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 | 필수 | PORT=9090 |
REMOTE_SOURCE_PROXY_DOMAINS | 원격 이미지 프록시를 적용할 도메인 목록 (쉼표로 구분) | 없음 | 선택 | example.com,.internal.local |
REMOTE_SOURCE_PROXY_TARGET | 내부망에서 접근 가능한 프록시 대상 베이스 URL | 없음 | 선택 | http://10.0.0.5:8080/remote/ |
| Note |
|---|
|
API
| Endpoint | Method | 설명 |
|---|---|---|
| /exportFile | POST | 웹 에디터가에서 직렬화한 문서(serializedData)와 이미지 리소스를 통해 특정 포맷의 문서로 |
| 반환 | ||
| /info | GET | 배포된 서버 정보(프로덕트 이름, 버전, Exporter 버전 등)를 |
| 조회 | ||
| /health | GET | 서버가 정상 기동 중인지 확인하는 헬스 체크 |