API 평가는 샘플 요청이 HTTP 200을 반환하는지 여부가 아니라 고객이 의도한 증거를 안정적으로 검색할 수 있는지 여부에 답해야 합니다. 먼저 워크플로를 정의합니다. 예를 들어 한 고객이 받은 증거를 내보냅니다. 집계 보고서 페이지를 잃어버리거나 세입자를 섞지 않고 개인 증거 저장소에 보관할 수 있습니다. 현재 계약이 확인될 때까지 명명된 제품이 이 인터페이스를 제공한다고 가정하지 마십시오.
계약과 경계를 고정하세요
공급자, 끝점, API 버전, 인증 방법, 테넌트 경계, 필드, 페이지 매김 규칙 및 문서화된 제한을 기록합니다. 보고서의 내용을 보고서가 도착한 시간 및 보고서의 기간과 분리합니다. API가 원시 보고서, 정규화된 행 또는 파생 결과를 반환하는지 여부를 지정합니다. 이는 서로 다른 증거 모집단이므로 서로 다른 조정 규칙이 필요합니다.
GitHub의 API 버전 문서 X-GitHub-Api-Version을 사용한 명시적인 버전 선택을 보여줍니다. 이는 버전 관리 관행의 구체적인 예이지 GitHub가 수출한다는 증거는 아닙니다. DMARC 보고서. 실제 평가를 위해 테스트하기 전에 검토 가능한 계약서에 해당 세부 사항을 기록하십시오. 이 가이드에서는 공급업체 계약, 엔드포인트 또는 제품 기능을 제공하지 않습니다.
출처 및 필드 테스트
정규화된 행의 경우 보고자, 보고서 ID, 원래 기간, 수신 시간 및 소스 지문(사용 가능한 경우)을 유지합니다. 승인된 보존 관리에 따라 원본 아티팩트를 보존합니다. RFC 9990 집계 보고서 구조에 대한 기본 참조입니다. 편리한 JSON 스키마는 보고된 개수를 전달된 메시지의 증거로 바꾸거나 수신자가 제공하지 않은 정보를 복구할 수 없습니다.
서비스가 부분 수집, 잘못된 보고서, 수정된 데이터 및 누락된 수집 기간을 어떻게 나타내는지 물어보세요. 페이지를 자동으로 건너뛰면 그럴듯한 측정항목이 잘못될 수 있습니다. 알려진 오류가 포함된 샘플을 요청하고 동일한 내보내기로 구동되는 다른 화면이 아니라 독립적으로 계산된 입력과 비교합니다.
의도적으로 실패 경로를 연습합니다.
다중 페이지 결과, 빈 결과, 중복 입력, 타임스탬프를 공유하는 두 개의 레코드, 취소된 자격 증명, 교차 테넌트 요청 및 일시적인 오류를 테스트합니다. 문서화된 연속 링크나 커서를 따르십시오. 속도 제한, 기록 상태, 관련 헤더 및 재시도 정책의 경우. GitHub의 모범 사례 속도 제한 신호를 존중하고 통제되지 않은 동시성을 피하는 것이 좋습니다. 정확한 한도는 여전히 실제 서비스 계약에 속합니다.
첫 번째 페이지는 저장되었지만 두 번째 페이지는 실패했다고 가정합니다. 첫 번째 요청에 대한 HTTP 200은 전체 내보내기를 정당화할 수 없습니다. 부분 상태를 유지하고 공급자가 지원하는 계속 또는 다시 시작 프로세스를 사용합니다. 이와 별도로, 인증된 다른 테스트 테넌트에 대해 성공적으로 인증된 요청은 호출자에게 해당 권한이 부족한 경우 계속 거부되어야 합니다. 이러한 가상 사례에서는 완전성과 승인이라는 다양한 요구 사항을 테스트합니다.
재시도 테스트의 경우 문서화된 속도 제한 응답과 영구 권한 실패를 구별하세요. GitHub의 속도 제한 문서 403 또는 429로 속도 제한을 보고할 수 있다고 설명하므로 오류 컨텍스트와 문서화된 헤더를 읽지 않고 모든 403을 영구적으로 재시도할 수 없는 것으로 분류하지 마십시오. 실제 공급자의 제한된 대기 및 재시도 규칙을 적용합니다. 여기서는 가상 시계, 재시작 테스트, 공급업체 호출 또는 실시간 액세스 제어 확인이 실행되지 않았습니다.
무엇이 허용되는지 결정
각각의 요구되는 행동, 획득한 증거, 남은 불확실성을 나열하는 평가 기록을 만듭니다. 누락된 테넌트 격리 또는 복구할 수 없는 데이터 손실을 중지 조건으로 처리합니다. 프로덕션 자격 증명이 부족하다고 해서 문서 평가를 막을 수는 없지만 실시간 액세스 제어가 테스트되었다고 주장하는 것은 불가능합니다.
서비스 소유자와 다음 단계에 동의합니다. 즉, 샌드박스 확보, 보호된 어댑터 구현 또는 지원되는 내보내기로 워크플로 범위를 좁힙니다. 나중에 공급자 변경 사항을 평가할 수 있도록 고정된 계약 및 테스트 설비를 유지합니다. 제품별 주장을 문서화되고 관찰된 기능으로 제한합니다. 이 가이드에서는 EmailAuth API 통합이 확인되지 않습니다.