10.3. URL 버전 관리

(후크별, 영화 제목별 등) 검색에 필요한 끝점이 다르면 URL 버전 지정을 사용하면 API 버전이 URI의 일부로 포함됩니다.

  1. api.songs.com/v1/songwriter
  2. api.songs.com/v2/songwriter
  3. api.songs.com/v1/song
  4. api.songs.com/v2/song
참고

이 방법을 사용할 때는 API를 버전할 v1 이후 계획해야 합니다.

그런 다음 3scale 게이트웨이는 URI에서 엔드포인트 및 버전을 추출합니다. 이 접근 방식을 사용하면 모든 버전/엔드포인트 조합에 대한 애플리케이션 계획을 설정할 수 있습니다. 그런 다음 메트릭을 해당 계획 및 끝점과 연결할 수 있으며 각 버전의 각 끝점에 대한 사용량을 차트로 작성할 수 있습니다.

다음 화면 캡처는 3scale의 유연성을 보여줍니다.

그림 10.1. 버전 관리 계획 기능

버전 관리 계획 기능

3scale 관리 포털의 [your_API_name] > Integration > Configuration 으로 이동하여 다음 다이어그램에 표시된 대로 URI를 메트릭에 매핑합니다.

그림 10.2. 메트릭에 URI 매핑

메트릭에 URI 매핑

이제 각각 다른 기능이 활성화되어 있는 두 가지 버전의 API가 있습니다. 또한 사용량에 대한 완전한 제어 및 가시성을 확보할 수 있습니다.

API v2로 이동해야 하는 모든 사용자와 통신하려면 해당 작업을 수행하도록 내부 메모를 보낼 수 있습니다. 누가 이동했는지 모니터링하고 v2에 대한 활동이 증가하는 동안 v1에 대한 활동이 어떻게 감소하는지 확인할 수 있습니다. 3scale에 권한 부여 호출에 메트릭을 추가하면 v1과 v2 엔드포인트를 사용하는 전체 트래픽 양을 확인할 수 있으며 v1을 사용 중단하는 것이 안전한 시기를 알 수 있습니다.

그림 10.3. 버전 관리

버전 관리

일부 사용자가 v1을 계속 사용하는 경우 해당 사용자만 필터링하여 v2로 전환하는 데 대한 다른 내부 노트를 보낼 수 있습니다.

3scale은 사용 중단 알림을 전송하는 3단계 방법을 제공합니다.

  1. 대상 > 애플리케이션 > 나열 으로 이동하여 사용 중단 노트를 보내려는 애플리케이션 계획별로 목록을 필터링하고 Search (검색)를 클릭합니다.
  2. multiselector를 클릭하여 특정 버전의 모든 애플리케이션을 선택합니다. 새로운 옵션은 Send email (이메일 전송),애플리케이션 계획 변경, 상태 변경 등의 대량 작업을 수행할 수 있도록 합니다.
  3. Send email (이메일 전송)을 클릭하고 단계에 따라 선택한 애플리케이션 소유자에게 사용 중단 알림을 보냅니다.

다음 이미지는 시각적 참조를 제공합니다.

그림 10.4. 폐기 노트 보내기

폐기 노트 보내기

엔드포인트에 만들어진 각 authrep 호출에 대해 한 번만 인증하지만 엔드포인트에 대해 한 번(한 번 보고) API 버전에 대해 한 번 보고합니다. 호출은 한 번만 인증될 수 있으므로 이중화는 없습니다. 특정 API 버전의 엔드포인트를 만들 때마다 버전 번호(v1, v2 등) 뒤에 이름이 지정된 편리한 지표에 대한 조회를 집계합니다. 이 지표에서는 를 사용하여 전체 버전 트래픽을 서로 비교할 수 있습니다.