소개

PlantUML을 사용하면 API 문서를 효율적으로 게시할 수 있음을 알 수 있습니다. 이번에는 PlantUML을 사용하여 API 문서를 작성하는 흐름을 기록해 두고 싶습니다.

PlantUML 설치

brew를 사용하면 쉽게 설치할 수 있으므로 사전에 brew를 설치해 두십시오.

$ brew install graphviz
$ brew install plantuml

plantuml에서 다음과 같은 체크섬 오류가 발생했습니다. 내 환경의 경우 brew upgrade를 수행하면 문제가 발생하지 않습니다.

$ brew install plantuml
==> Downloading https://downloads.sourceforge.net/project/plantuml/1.2018.1/plantuml.1.2018.1.jar
==> Downloading from https://downloads.sourceforge.net/#!/project/plantuml/1.2018.1/plantuml.1.2018.1.jar
######################################################################## 100.0%
Error: SHA256 mismatch

$ brew upgrade
$ brew install plantuml
==> Downloading https://downloads.sourceforge.net/project/plantuml/1.2018.1/plantuml.1.2018.1.jar
==> Downloading from https://jaist.dl.sourceforge.net/project/plantuml/1.2018.1/plantuml.1.2018.1.jar
######################################################################## 100.0%
🍺  /usr/local/Cellar/plantuml/1.2018.1: 4 files, 6.9MB, built in 8 seconds

Atom plantuml 플러그인 설치

다음 세 가지 플러그인을 설치합니다.

plantuml

plantuml-viewer

markdown-preview-enhanced

Atom의 Preference에서 Install을 선택

plantuml을 입력하여 패키지 검색

plantuml 및 plantuml-viewer 설치

markdown-preview-enhanced를 입력하여 패키지 검색

markdown-preview-enhanced 설치

markdown-preview-enhanced를 사용하려면 markdown-preview 설정을 해제합니다.

API 문서 작성

API 문서풍으로 기술해 보았습니다. 다음과 같이 Markdown 안에 plantuml 메타데이터를 삽입할 수 있으므로 그림을 PNG로 떨어뜨리는 등의 번거로움이 없어 매우 도움이 됩니다.