프로젝트 소개

Ultralytics OpenAPI는 OpenAPI 사양(버전 3.0~3.2.0)을 읽고 단일 계약에서 두 가지 출력을 생성하는 도구입니다: 대화형 API 문서와 타입화된 Python SDK. 모든 표준 HTTP 작업(GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, TRACE)을 지원합니다. 구성은 `openapi.config.json` 파일을 통해 이루어지며, 여기서 소스(로컬 파일 또는 URL), 생성된 패키지 이름, API 키 환경 변수, 문서 기본 경로, 다양한 Python 패키지 메타데이터(작성자, 분류자, 버전, 라이선스 등)를 지정합니다. 이 도구는 또한 소비자가 소유한 Python 소스 파일을 포함하여 선택적 CLI 생성을 지원합니다. 주요 기능은 다음과 같습니다: - 동기 및 비동기 Python 클라이언트 - 타입화된 리소스 및 TypedDict 응답 - 멀티파트 업로드 지원 - 임시 실패에 대한 자동 재시도 - 구조화된 API 오류 - 문서용 브라우저 메모리에 유지되는 API 키 처리 - 결정적 정적 문서 빌드 - 사용자 지정 가능한 브랜딩(로고, 파비콘, 그라디언트 토큰) - 사용자 지정 자격 증명 검색을 위한 선택적 인증 제공자 모듈 생성된 SDK는 기본적으로 AGPL-3.0 라이선스를 사용하지만 구성할 수 있습니다. 이 프로젝트는 Bun과 uv로 개발되었으며, 개발, 테스트, 생성을 위한 명령을 포함합니다. TypeScript, Go, Java용 SDK가 계획되어 있습니다.