대부분의 애플리케이션은 어떤 형태로든 클라이언트 SDK 또는 API URL을 사용하여 작성됩니다. 클라이언트 SDK 및 API URL은 특정 Looker API 버전에 바인딩됩니다. Looker가 새 API 버전을 변경하더라도 애플리케이션은 계속 작동합니다. 새 Looker API 버전을 사용하도록 클라이언트 SDK를 업그레이드하거나 API URL을 수정하기 전까지 다른 API 버전의 변경사항이 애플리케이션에 영향을 주지 않습니다.
Looker가 API를 변경하는 방법
Looker API는 Looker API 엔드포인트에 안정성을 제공하도록 설계되었으므로, 애플리케이션에 안정성을 제공합니다.
Looker에 더 많은 기능을 추가할수록 Looker REST API도 업데이트하여 이러한 새 기능에 액세스하거나 이를 관리할 수 있습니다. 각 Looker 출시 버전의 경우 Looker API의 현재 버전에 새로운 API 함수, 매개변수, 응답 유형 속성이 추가됩니다. 대부분의 경우 API에 추가해도 브레이킹 체인지가 되지 않으므로 API를 기반으로 개발된 기존 애플리케이션 코드에 영향을 주지 않고 API의 기존 버전을 유지할 수 있습니다. 기존 애플리케이션 코드는 단순히 Looker 출시 버전에 나타나는 새로운 함수, 매개변수 또는 기능을 인식하지 못할 수도 있습니다.
기존 애플리케이션 코드가 손상되는 API 변경사항의 경우 이러한 브레이킹 체인지를 새 API 버전으로 묶습니다. 즉, 이전 API 버전은 이전과 동일하게 작동하지만 새로운 API 버전은 변경사항 및 업데이트와 함께 실행됩니다. 단일 Looker 인스턴스에 여러 API 버전이 나란히 존재할 수 있으므로 새 API 버전으로 업그레이드할 시간을 선택할 수 있습니다. 이전 엔드포인트를 호출하도록 빌드된 기존 코드는 이전 엔드포인트를 계속 호출합니다. 새 코드는 최신 API 버전 수준에서 새 버전의 엔드포인트를 호출해야 합니다.
중요한 보안 문제에 대해서는 예외입니다. Google에서는 API의 특정 부분과 관련된 중요한 보안 문제를 발견하는 경우 가능한 한 빨리 이러한 보안 문제를 완화하기 위해 필요한 조치를 취하고, 여기에는 적절한 해결책이 제공될 때까지 취약한 기능의 사용 중지가 포함될 수 있습니다.
더 나은 구현이나 솔루션을 위해 기능, 함수 또는 속성을 사용 중지해야 하는 경우 일반적으로 현재 API를 그대로 두지만, 애플리케이션 코드의 엔드포인트에서 벗어나야 함을 나타내기 위하여 연결된 API 엔드포인트를 '지원 중단됨'으로 표시합니다.
API에 대한 브레이킹 체인지와 추가 변경사항
브레이킹 체인지는 API 엔드포인트의 기존 아티팩트를 삭제하거나 이름을 변경하는 것입니다. 여기에는 다음이 포함될 수 있습니다.
- 매개변수 이름 또는 유형 변경 또는 삭제
- 새 필수 매개변수 추가
- 기준 URL 변경
- 응답에서 기존 속성 변경 또는 삭제
반면에 추가 변경이 안정적인 엔드포인트에 적용될 수 있습니다. 여기에는 다음이 포함될 수 있습니다.
- 새로운 선택적 매개변수
- 응답의 새 속성(코드에서 REST API 커뮤니티에서 일반적으로 사용되는 알 수 없는 속성을 무시한다고 가정하기 때문에 호환성이 손상되는 것은 고려되지 않음)
안정적인 Looker API 엔드포인트를 새로운 아키텍처나 기능으로 계속 진행하기 위해 상당한 변경이 필요한 경우 변경사항은 일반적으로 새 엔드포인트에 추가되고 새 API 버전에 번들로 제공되어 기존 API 엔드포인트가 변경되지 않습니다.
API 엔드포인트 플래그
대부분의 API 엔드포인트는 안정화된 것으로 간주되므로 변경될 수 없습니다. Looker는 보안 문제 해결과 같은 극단적인 경우를 제외하고 안정적인 엔드포인트에 브레이킹 체인지를 적용하지 않습니다.
다른 API 엔드포인트는 베타 또는 지원 중단으로 표시될 수 있습니다.
- 베타 엔드포인트는 현재 개발 중이며 향후 변경될 수 있습니다. 브레이킹 체인지로부터 보호되지 않습니다. 베타 엔드포인트를 사용할 때 Looker API로 인해 변경사항이 앱 또는 개발 주기에 특히 지장을 주는지 여부를 고려하세요. 변경 사항을 확인할 수 있도록 베타 엔드포인트를 사용하려면 Looker의 출시 노트를 읽어보시기 바랍니다.
- 지원 중단된 엔드포인트는 계속 지원되며 현재 계속 사용할 수 있지만 향후 출시 버전에서 삭제될 예정입니다. 지원 중단된 엔드포인트를 사용하는 이전 코드를 지원 중단된 엔드포인트의 사용을 중지하도록 업데이트해야 합니다. 이후 출시되는 Looker에서 해당 엔드포인트에 대한 지원을 중단하면 아직 사용 중인 코드는 손상됩니다. 대부분의 경우 지원 중단된 엔드포인트는 개선된 기능으로 대체됩니다. 애플리케이션에서 지원 중단된 함수 또는 속성을 사용하고 있는 경우 가능한 한 빨리 지원 중단된 요소를 대체하도록 코드를 리팩터링하는 것이 좋습니다.
베타 및 지원 중단된 엔드포인트는 API 탐색기와 4.0 API 참조에 다음과 같이 표시됩니다. 표시되지 않은 엔드포인트는 안정적인 것으로 간주됩니다.
새 API 버전으로 마이그레이션
클라이언트 SDK 또는 API URL을 새 API 버전으로 업그레이드하는 경우 새 API 버전으로 변경된 사항을 사용하고 있는지 확인하기 위해 애플리케이션 코드를 검토해야 합니다. 다음 안내를 따르세요.
- 애플리케이션 코드에서 업데이트된 함수, 값, 속성 이름을 검색합니다.
- 애플리케이션 코드가 유형 변경(예: 정수에서 문자열)을 지원하는지 확인합니다.
- 코드를 감사합니다(아래 섹션 참조).
코드 감사
일부 언어의 경우 빌드 시간에 컴파일 오류로 API의 브레이킹 체인지를 발견할 수 있습니다.
- 강력하게 형식이 지정된 언어로 애플리케이션이 작성되는 경우, 기존 코드와 상충하는 새 API 버전의 매개변수 또는 응답 유형의 구조적 변경사항은 컴파일 유형 확인 및 컴파일러 오류 메시지 덕분에 명확히 드러나게 됩니다.
- 유형이 느슨하게 지정된 동적 언어(예: 자바스크립트, Ruby, Python)로 애플리케이션이 작성된 경우 새 API 버전에서 브레이킹 체인지의 영향을 받는 애플리케이션 부분을 찾기가 더 어려울 수 있습니다. 이러한 유형의 언어는 유형 변경과 관련된 문제를 찾기 위해 런타임 단위 테스트가 필요할 수 있습니다.
모든 경우에 가장 좋은 방법은 Looker API(모의 호출이 아님) 호출을 포함하여 애플리케이션 코드를 실행하는 단위 테스트를 하는 것입니다.