웹API 디자인

2022, Jan 31    

API 설계시 꼭 체크해보기

  1. 사용자를 위한 API 디자인하기 2.3.5 API 목표 캔버스
    • 누가 - API를 사용하는 사용자들을 나열
    • 무엇을 - API로 사용자들이 할 수 있는 것을 나열
    • 어떻게 - 무엇을 단계별로 분해해 나열
    • 입력(원천) - 각 단계를 진행하기 위해 필요한 요소들과 그것들의 원천을 나열(누락된 누가, 무엇을 또는 어떻게를 찾기 위함)
    • 출력(사용처) - 각 단계의 반환과 그 쓰임새를 나열(누락된 누가, 무엇 또는 어떻게를 찾기 위함)
    • 목표 - 명시적이고 간결하게 각각의 어떻게 + 입력 + 출력을 재구성
  2. 기존 API를 변경할 때
    • 브레이킹 체인지가 일어나지 않도록해야한다.