Software Engineer, Java, Spring Boot, JAX-RS REST API, OAuth 2.0, Microservice, DevOps

API 문서 작성 방법의 변화 API 레퍼런스 문서를 작성하는 가장 원시적이면서 일반적인 형태는 리비전이 발생할 때마다 마이크로소프트 워드 파일을 직접 작성하여 클라이언트에게 배포하는 것이다. 국내 개발자들에게 가장 익숙한 방식이기도 하다. 현재 가장 유행하는 형태는 첫번째, API 문서 작성 포맷을 규정하고, 두번째, 그 포맷에 맞게 텍스트 파일을 작성하면, 세번째, 렌더러를 통해 멋지게 화면에 뿌려주는 것이다. API를 구현한 언어적 특성에 따라 두번째 방법이 소스 코드 상에서 자동화되기도 한다. 현재 무료로 공개된 대부분의 오픈 소스 API 문서 작성 도구들은 이러한 패턴을 따른다. 한편 렌더러 측면에서 최근 가장 보편적인 화면 구성 레이아웃은 화면을 3등분한 3패널 디자인이다. 좌측에는 메뉴를, ..