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

OAuth 2.0 사용 여부 결정 API 서버 설계시 가장 먼저 고려할 점은 클라이언트에게 1개 이상의 인증 방법을 제공할 수 있어야 한다. 대표적으로 OAuth 2.0과 API Keys(Basic Auth) 방식이 존재한다. 클라이언트가 API 서버에 요청하는 데이터가 특정 사용자와 무관한 공개적 성격(지도, 날씨 등)을 가진다면 OAuth 2.0을 사용하지 않고 api_key, api_secret를 발급하는 것으로 충분하다. 단지 요청이 유효한 클라이언트인지를 식별해주는 역할을 수행한다. 하지만 데이터가 특정 사용자와 연관된 개인적 성격(특정 사용자의 동의가 필요한 개인 데이터 등)을 가진다면 OAuth 2.0을 사용해야 하므로 client_id, client_secret을 발급해야 한다. [관련 링..

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

Slate란? Slate는 HTML 형태의 API 문서를 만들어주는 도구이다. 정확히는 Ruby 기반의 HTML 실시간 렌더링, 빌드 기능을 가진 애플리케이션이다. Slate의 강점은 낮은 학습곡선, 자유도와 생산성이다. 흔히 API 툴링시 많이 도입하는 Swagger 2, ReDoc 조합이 여의치 않을 경우 매력적인 대안이 될 수 있다. Slate 다운로드 후 하위 /source 디렉토리의 Markdown 문서들을 기반으로 API 문서를 작성하면 Slate가 미려한 UI의 반응형 웹으로 변환해준다. 실시간으로 마크다운 문서를 확인할 수 있으며 또한 배포 목적의 HTML 빌드 기능도 제공한다. Slate는 아주 간단한 Markdown 문법 만을 제공하기에 자유도가 상당히 높다. 문법 중간 중간 HTML과..