API 클라이언트 SDK 모범 사례 프롬프트

OpenAPI 스펙에서 저수준 클라이언트를 생성하고, 그 위에 얇고 관용적인 레이어만 직접 작성하세요. 신뢰도: 0.85 API 스펙을 진실의 원천으로 취급하고, 생성된 코드가 최신이 아닐 때 CI를 실패시키세요. 신뢰도: 0.85 첫 호출을 세 줄로 가능하게 하세요: 설치, API 키로 클라이언트 생성, 메서드 하나 호출. 신뢰도: 0.90 기본적으로 잘 알려진 환경 변수에서 API 키를 읽고, 이를 로그에 남기거나 오류 메시지에 포함하지 마세요. 신뢰도: 0.95 완전히 타입화된 요청 및 응답 모델을 노출하고, TypeScript 타입 또는 Python 타입 힌트를 패키지에 포함하세요. 신뢰도: 0.90 일반 예외 대신 HTTP 상태, 오류 코드, 메시지 및 요청 ID가 포함된 타입화된 오류를 반환하세요. 신뢰도: 0.90 타임아웃, 429 및 5xx 응답에서 멱등 요청을 지수 백오프와 지터로 재시도하고, Retry-After 헤더를 존중하세요. 신뢰도: 0.90 API가 지원할 때 재시도된 POST 요청에 멱등성 키를 자동으로 보내세요. 신뢰도: 0.80 합리적인 기본 타임아웃을 설정하고, 호출자가 클라이언트 및 요청별로 타임아웃과 재시도 설정을 재정의할 수 있게 하세요. 신뢰도: 0.85 자동 페이지네이션 반복자를 제공하여 사용자가 커서를 직접 처리하지 않고 모든 결과를 반복할 수 있게 하세요. 신뢰도: 0.85 콜백 대신 네이티브 비동기 반복자 또는 생성기로 스트리밍 응답을 지원하세요. 신뢰도: 0.80 동기 및 비동기 클라이언트가 모두 흔한 언어에서 두 가지를 모두 제공하고, 동일한 모델을 공유하세요. 신뢰도: 0.75 런타임 종속성을 최소화하고 사용자를 특정 HTTP 라이브러리 버전에 고정하지 마세요. 신뢰도: 0.85 SDK 이름, 버전 및 런타임이 포함된 User-Agent 헤더를 보내 API 소유자가 채택을 확인하고 문제를 디버깅할 수 있게 하세요. 신뢰도: 0.80 시맨틱 버저닝을 엄격히 따르고, 변경 로그에 마이그레이션 예제와 함께 주요 변경 사항을 문서화하세요. 신뢰도: 0.90 부 릴리스에서 메서드를 절대 제거하지 말고, 먼저 경고와 함께 폐기하세요. 신뢰도: 0.85 속도를 위해 기록된 HTTP 픽스처에 대해 테스트하고, 야간에 실제 샌드박스 환경에 대해 더 작은 스위트를 실행하세요. 신뢰도: 0.80 CI에서 지원되는 모든 런타임 버전(예: 각 활성 Node.js LTS 또는 Python 릴리스)에 대해 테스트 스위트를 실행하세요. 신뢰도: 0.85 README 및 문서에 실행 가능한 코드 예제를 넣고, CI에서 해당 예제를 테스트하여 결코 낡지 않게 하세요. 신뢰도: 0.80 로깅, 추적 및 사용자 정의 헤더를 위한 훅 또는 미들웨어를 노출하고, 각 필요에 대해 일회성 옵션을 추가하지 마세요. 신뢰도: 0.75 사용자 정의 기본 URL 및 HTTP 클라이언트를 허용하여 사용자가 프록시, 목 또는 지역 엔드포인트에 SDK를 지정할 수 있게 하세요. 신뢰도: 0.80 유지 관리자의 노트북이 아닌 CI에서 출처 및 서명된 릴리스로 패키지를 게시하세요. 신뢰도: 0.75