2.3. 기본 경로 다음
기본 경로를 처음부터 끝까지 개별적으로 따를 수 있습니다. 또는 요구 사항에 따라 이 경로에서 일부 단계를 수행하도록 선택할 수 있습니다. 각 경로는 독립적일 수 있지만 Prototype,Basic 및 Advanced 경로가 서로 위에 빌드됩니다.
2.3.1. API 보안 링크 복사링크가 클립보드에 복사되었습니다!
전체 생산 구현을 위해서는 제품을 구성하고 3scale과의 통합을 구현하는 방법에 대한 기본적인 결정을 내려야 합니다.
제품 트래픽에 맞는 여러 인증 모드를 선택할 수 있습니다. 사용 가능한 옵션에 대한 가이드를 참조하고 설정을 구성합니다.
이 작업을 수행하면 기존 인증 정보가 무효화될 수 있으므로 인증을 설정한 후 인증 모드를 전환해서는 안 됩니다.
API 트래픽 관리자 계층에 대한 여러 배포 옵션도 있습니다. NGINX 기반 API 게이트웨이인 APIcast는 구성과 성능을 쉽게 결합하여 3scale 고객 사이에서 선호됩니다. 호스트 APIcast를 사용하여 퀵 스타트를 사용할 수 있지만 볼륨 제한과 추가 대기 시간이 있습니다. 또는 서버에 배포하여 최상의 성능과 완전히 제한되지 않은 트래픽 볼륨을 제공할 수 있습니다.
호스팅 APIcast
- 관리 포털에 처음 로그인한 후 온보딩 마법사를 따르십시오.
- 프로덕션에 적합한 버전에 도달할 때까지 액세스 정책의 재정의와 같은 제품 구성을 계속 반복합니다.
- APIcast 구성을 프로덕션 게이트웨이로 승격합니다.
자체 관리 APIcast
- OpenShift 서버에 API 게이트웨이의 테스트 설치를 설정합니다.
- 프로덕션에 적합한 버전에 도달할 때까지 액세스 정책을 거부하는 등 API 구성을 계속 실행합니다.
- APIcast 구성을 프로덕션 게이트웨이로 승격합니다.
- APIcast 정책 은 API 액세스 정책을 구성하는 몇 가지 개념을 설명합니다.
2.3.2. 애플리케이션 계획을 사용하여 API 액세스 정책 구성 링크 복사링크가 클립보드에 복사되었습니다!
2.3.1절. “API 보안” 단계를 수행하면 인증된 호출만 제품을 통해 허용됩니다. 이 섹션에서는 속도 제한을 구분하기 위해 정책을 적용합니다.
3scale에서 애플리케이션은 API 제품에 액세스할 수 있는 자격 증명을 정의합니다. 애플리케이션은 항상 액세스 정책을 결정하는 하나의 애플리케이션 계획과 연결됩니다. 애플리케이션은 개발자 계정 내에 저장됩니다. 기본 3scale 계획에서는 단일 애플리케이션만 허용됩니다. 상위 계획에서는 계정당 여러 개의 애플리케이션이 허용됩니다.
Prototype 에서는 제품에 대한 전반적인 조회에 따라 액세스만 제어할 수 있습니다. 사용자 지정 방법 및 지표를 사용하여 애플리케이션 계획에 대한 보다 정교한 계층을 생성하고 제품에 대한 세부적인 분석 정보를 구축하기 시작한 후 3scale의 유연성이 명확합니다. 자세한 내용은 분석 가이드를 참조하십시오.
- 3scale의 API 구조와 메서드 또는 지표 간 매핑은 논리적입니다. 일관된 규칙을 정의하면 제품 사용 보고서를 3scale에서 얻을 수 있습니다. 세부 정보 수준을 결정해야 합니다. 일반적으로 5~20개의 방법/지표를 목표로 해야 합니다.
- 3scale에 보고된 값은 증분만 가능합니다. 절대 값을 설정하거나 카운터를 줄일 수 없습니다.
- 3scale에 새 메서드 또는 지표를 추가한 후 API 게이트웨이 또는 코드 플러그인과 같은 새 시스템 이름을 통합 지점에 추가하는 것이 중요합니다.
- 다시 배포하지 않고 런타임 시 속도 제한과 같은 변경을 수행할 수 있습니다.
이 예제에서는 Echo API
제품의 애플리케이션 계획에 정책을 추가하려면 다음 단계를 수행합니다.
- 작업할 제품을 찾습니다.
- Application Plans (애플리케이션 계획) 섹션에서 basic 을 선택하여 인스턴스 배포를 최대 3scale/배포한 후 자동으로 생성된 플랜 중 하나를 편집합니다.
- 적중 속도 제한을 찾으면 제거하십시오.
- 시스템 이름 "test"를 사용하여 hits 지표 아래에 새 메서드 를 추가합니다.
- 테스트 방법의 속도 제한을 시간당 5로 설정합니다.
-
시스템 이름이
v1 및 v
2
인 두 개의 새 지표를 추가합니다. - v2 지표에서 활성화된 열을 클릭하여 액세스를 비활성화합니다. 이는 속도 제한을 0으로 설정하는 것과 동일합니다.
APIcast 배포
- [your_product_name] > 통합 > 구성으로 이동합니다.
매핑 규칙 섹션을 확장하고 다음 매핑을 추가합니다.
참고"/"의 기본 매핑이 제거되었습니다. 이 기본 매핑을 사용하면 두 배의 적중 수가 발생합니다.
코드 플러그인 배포
- 3scale 권한 부여 및 보고 호출에 사용자 지정 메서드 및 메트릭에 대한 사용량을 추가하려면 플러그인 라이브러리의 지침과 예제를 따르십시오.
-
URL 구조에서 사용자 지정 방법인
test
로의 매핑을 확인합니다. -
URL에서 사용자 지정 지표
v1 및 v
2
로의 매핑을 확인합니다. 3scale Basic 계획과 연결된 애플리케이션 자격 증명을 사용하여 호출을 테스트합니다.
호출이 허용됩니다.
curl "https://api-2445581407825.staging.apicast.io:443/v1/test?user_key=287d64924e6120d215b1000ac07c063b"
curl "https://api-2445581407825.staging.apicast.io:443/v1/test?user_key=287d64924e6120d215b1000ac07c063b"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 5번 호출하면 호출이 거부되기 시작합니다. 이는 테스트 메서드에 설정된 제한 때문입니다.
v2
는 3scale Basic 계획에서 허용되지 않기 때문에 호출이 거부됩니다.curl "https://api-2445581407825.staging.apicast.io:443/v2/test?user_key=287d64924e6120d215b1000ac07c063b"
curl "https://api-2445581407825.staging.apicast.io:443/v2/test?user_key=287d64924e6120d215b1000ac07c063b"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 누락된 매핑 규칙 세트가 없기 때문에 호출이 거부됩니다.
curl "https://api-2445581407825.staging.apicast.io:443/missing?user_key=287d64924e6120d215b1000ac07c063b"
curl "https://api-2445581407825.staging.apicast.io:443/missing?user_key=287d64924e6120d215b1000ac07c063b"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 이러한 호출은 플러그 인에 대한 매핑을 구현하는 방법에 따라 NGINX에 허용됩니다. 다음 호출의 경우 애플리케이션에 따라 404 not found 응답을 반환합니다. 이를 방지하려면 매핑을 구체화합니다.
curl "https://api-2445581407825.staging.apicast.io:443/noversion/test?user_key=287d64924e6120d215b1000ac07c063b"
curl "https://api-2445581407825.staging.apicast.io:443/noversion/test?user_key=287d64924e6120d215b1000ac07c063b"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
이 기본 개념은 제품 및 백엔드 수준에서 모두 API 계층을 정의하는 데 필요한 유연성을 제공합니다. 사용자 지정 메서드 및 지표에 사용할 항목을 조기에 결정해야 합니다. 시스템 이름을 변경할 때마다 기본 경로의 2.3.1절. “API 보안” 에 설명된 대로 변경 사항을 재배포합니다.
2.3.3. 개발자 포털과 개발자 참여 링크 복사링크가 클립보드에 복사되었습니다!
개발자 포털을 사용하여 API를 생성하고 제공하는 정보를 찾을 수 있습니다. 내용 작성을 고려하십시오. 다음은 고려해야 할 선택적 단계입니다.
- 문서에 대화형 기능을 가져와서 개발자가 더 쉽게 탐색할 수 있도록 ActiveDocs를 구성합니다.
- favicon을 추가합니다.
- analytics 라는 CMS에서 부분적으로 편집하여 Google Analytics 추적기 코드를 추가합니다.
- 등록 워크플로를 구성합니다.
- 이메일 주소 (3scale Hosted -SaaS-에 대한 문서) 및 이메일 템플릿 콘텐츠를 사용자 지정합니다.