마이크로서비스의 API를 설계할 때 참고할 수 있는 패턴들을 소개하는 책이다. 이 패턴은 입증되고 재사용 가능한 솔루션 엘리먼트를 통해 API 설계 및 발전의 복잡성을 극복하는 데 도움을 주는 것을 목표로 패턴 커뮤니티는 피드백 프로세스를 통해 정립된 내용을 소개한다. HTTP, 웹 API, 서비스 지향 아키텍처를 포함한 일반적인 통합 아키텍처에 적용 가능한 패턴뿐 아니라, 개별 API 엔드포인트와 메시지 교환과 관련된 패턴 그리고 API의 진화와 관련된 패턴도 소개한다. 이러한 패턴들은 프로그램 내부 API가 아닌 원격 API(remote API)에 초점을 맞춰 클라이언트 측과 프로바이더 측 모두에서 개발자 경험을 개선하는 것을 목표로 한다.
아일랜드에 있는 더블린시티 대학교(DublinCity University)에서 박사 학위를 받고, 2010년부터 안드로이드 기반 휴대폰 소프트웨어의 멀티미디어 기능 및 서비스 개발 업무를 리드하며 소프트웨어 아키텍트로 활동하고 있다. 소프트웨어 아키텍처, 애자일 방법론(특히 애자일 매니지먼트)에 관심이 많고, 최근에는 ChatGPT와 같은 LLM(Large Language Model)과 연계해 업무 효율화, 전문성 훈련과 같은 개인적 관심뿐 아니라 다른 사람들의 문제 해결, 서비스와 연계 및 아키텍처 설계에 대해 분야를 확대해 가고 있다.
1부. 기초와 내러티브01장.애플리케이션 프로그래밍 인터페이스(API) 기초__로컬 API에서 원격 API로____분산과 원격에 대한 간략한 역사____원격 API: 통합을 위한 프로토콜 기반 서비스 액세스____API의 중요성__API 설계의 의사 결정 드라이버____API를 성공하게 하는 것____여러 API 설계 방법____API 설계가 어려운 이유____아키텍처적으로 중요한 요구 사항____개발자 경험__원격 API의 도메인 모델____커뮤니케이션 참가자____엔드포인트 제공 동작을 설명하는 계약____대화의 빌딩 블록으로서의 메시지____메시지 구조 및 표현____API 계약____책 전반에서 사용되는 도메인 모델__요약__02장.호반 상호 보험 사례 연구__비즈니스 콘텍스트 및 요구 사항____사용자 스토리 및 요구되는 품질____분석 수준 도메인 모델__아키텍처 개요____시스템 콘텍스트____애플리케이션 아키텍처__API 설계 활동__목표 API 사양__요약__03장.API 의사 결정 관련 사항__들어가기: 의사 결정 옵션으로서의 패턴, 의사 결정 기준으로서의 포스__기본적인 API 의사 결정과 패턴____API 가시성____API 통합 타입____API 문서화__API 역할과 책임에 대한 의사 결정____엔드포인트의 아키텍처 역할____정보 보유자 역할 정제____동작 책임 정의__메시지 표현 패턴 선택하기____표현 엘리먼트의 평면 구조와 중첩 구조____엘리먼트 스테레오타입__중간 짚어보기: 호반 상호 보험 사례의 책임과 구조 패턴__API 품질 거버닝____API 클라이언트의 식별 및 인증____API 사용량에 대한 미터링 및 과금____API 클라이언트의 과도한 API 사용 방지____품질 목표 및 페널티의 명시적 지정____오류에 대한 커뮤니케이션____명시적 콘텍스트 표현__API 품질 개선을 위한 의사 결정____페이지네이션____불필요한 데이터 전송을 피하는 다른 방법____메시지에서 참조된 데이터 처리__API 진화에 대한 의사 결정____버전 및 호환성 관리____버전의 도입 및 폐기를 위한 전략__중간 짚어보기: 호반 상호 보험 사례의 품질 및 진화 패턴__요약____2부. 패턴04장.패턴 언어 개요__위치와 범위__패턴: 왜 그리고 어떻게?__패턴 탐색____구조의 구성: 범위별 패턴 찾기____테마별 분류: 주제별 패턴 찾기____시간 차원: 설계 개선 단계 따르기____탐색 방법__기초 패턴: API 가시성 및 통합 타입____패턴: 프론트엔드 통합____패턴: 백엔드 통합____패턴: 퍼블릭 API____패턴: 커뮤니티 API____패턴: 솔루션 내부 API____기초 패턴 요약__기본 구조 패턴____패턴: 아토믹 파라미터____패턴: 아토믹 파라미터 리스트____패턴: 파라미터 트리____패턴: 파라미터 포리스트____기본 구조 패턴 요약__요약__05장.엔드포인트 타입과 동작 정의__API 역할 및 책임의 소개____도전 과제와 요구되는 품질____패턴 설명__엔드포인트 역할: 서비스 세분성____패턴: 처리 리소스____패턴: 정보 보유자 리소스____패턴: 운용 데이터 보유자____패턴: 마스터 데이터 보유자____패턴: 참조 데이터 보유자____패턴: 링크 조회 리소스____패턴: 데이터 전송 리소스__동작 책임____패턴: 상태 생성 동작____패턴: 인출 동작____패턴: 상태 전이 동작____패턴: 계산 함수__요약__06장.요청 및 응답 메시지 표현 설계__메시지 표현 설계 소개____메시지 표현을 설계할 때의 과제____6장의 패턴__엘리먼트 스테레오타입____패턴: 데이터 엘리먼트____패턴: 메타데이터 엘리먼트____패턴: ID 엘리먼트____패턴: 링크 엘리먼트__특수 목적 표현____패턴: API 키____패턴: 오류 보고____패턴: 콘텍스트 표현__요약__07장.품질을 위한 메시지 설계 개선__API 품질 개요____API 품질의 개선 관련 도전 과제____7장의 패턴__메시지 세분성____패턴: 임베디드 엔티티____패턴: 링크된 정보 보유자__클라이언트 주도 메시지 콘텐츠 또는 응답 셰이핑____패턴: 페이지네이션____패턴: 위시 리스트____패턴: 위시 템플릿__메시지 교환 최적화(대화 효율성)____패턴: 조건부 요청____패턴: 요청 번들__요약__08장.API 진화__API 진화 소개____API를 진화시킬 때의 도전 과제____8장의 패턴__버전 관리 및 호환성 관리____패턴: 버전 식별자____패턴: 시맨틱 버전 관리__수명주기 관리 보장____패턴: 실험적 미리 보기____패턴: 공격적 폐기____패턴: 제한적 수명 보장____패턴: 2개의 상용 버전__요약__09장.API 계약 문서화 및 커뮤니케이션__API 문서화 개요____API 문서화의 도전 과제____9장의 패턴__문서화 패턴____패턴: API 설명____패턴: 요금 책정 플랜____패턴: 사용 비율 제한____패턴: 서비스 수준 계약__요약____3부. 패턴 사용의 현재와 미래10장.실제 패턴 사례__스위스 모기지 분야의 대규모 비즈니스 프로세스 통합____비즈니스 콘텍스트 및 도메인____기술적 과제____API의 역할과 현황____패턴 사용 및 구현____회고 및 전망__건설 영역의 제안 및 주문 프로세스____비즈니스 콘텍스트 및 도메인____기술적 과제____API의 역할 및 현황____패턴 사용 및 구현____회고 및 전망__요약__11장.결론__짧은 회고__API 관련 연구: 패턴, MDSL 등으로 리팩토링__API의 미래__추가 참고 내용__최종 코멘트부록 A.엔드포인트 식별 및 패턴 선택 가이드부록 B.호반 상호 보험 사례의 구현부록 C.마이크로서비스 도메인 특화 언어(MDSL)
