openai/openai-openapi

OpenAPI specification for the OpenAI API

해결하는 문제

OpenAI REST API에 대한 기계 판독 가능하고 표준화된 설명을 제공합니다. 이는 엔드포인트, 인증 및 요청/응답 스키마에 대한 단일 정보 출처를 제공하여 개발자가 클라이언트 라이브러리나 API 탐색기를 수동으로 작성할 필요성을 제거합니다.

작동 방식

이 프로젝트는 OpenAPI 3.1 형식(.yaml 및 .json 파일로 제공)으로 OpenAI API 정의를 게시합니다. 이 파일들은 업스트림 소스에서 동기화된 생성 산출물로, OpenAPI 생태계를 지원하는 모든 도구로 가져와 API 통합 개발을 자동화할 수 있습니다.

대상 독자

OpenAPI 호환 워크플로를 사용하여 타입화된 클라이언트, API 탐색기를 구축하거나 OpenAI API용 테스트 도구를 구성하려는 개발자.

주요 특징

  • 표준화된 형식: 업계 도구와의 폭넓은 호환성을 위해 OpenAPI 3.1을 사용합니다.
  • API용 SBOM: Python, JavaScript, .NET, Go, Java, Ruby와 같은 언어의 공식 OpenAI SDK의 기반 역할을 합니다.
  • 자동 동기화: 사양은 정확성을 보장하기 위해 업스트림 소스에서 자동으로 동기화됩니다.

관련

  • 프로젝트
    openai/openai-python

    OpenAI API용 공식 Python SDK로, 동기/비동기 클라이언트, 채팅, 완성, 비전, 실시간 오디오, 스트리밍, 페이지네이션, 파일 업로드, 웹훅 검증, 그리고 현대적인 워크로드 아이덴티티 인증(K8s, Azure, GCP, X.509)을 완전히 타입 체크된 방식으로 제공.

  • 프로젝트
    openai/openai-node

    OpenAI REST API용 공식 TypeScript 및 JavaScript 라이브러리로, 텍스트, 비전, 실시간 멀티모달 모델에 대한 타입 액세스를 제공합니다.

  • 프로젝트
    openai/openai-go

    Go로 작성된 애플리케이션을 위한 OpenAI REST API에 타입 안전하게 접근할 수 있는 공식 OpenAI Go 라이브러리입니다.

  • 프로젝트
    openai/openai-cli

    OpenAI CLI는 OpenAI REST API를 위한 공식 명령줄 클라이언트입니다. Homebrew 또는 `go install`을 통해 설치하고, API 키를 설정한 후 `openai responses create` 또는 관리자 쿼리를 실행할 수 있습니다. 커스텀 헤더, 상호 TLS (mTLS), 유연한 출력 형식, 파일 업로드, 그리고 모든 OpenAI Go SDK 버전과 연결할 수 있습니다. Apache 2.0 라이선스로 제공됩니다.

  • 프로젝트
    openai/openai-dotnet

    .NET 애플리케이션용으로 OpenAI REST API에 편리하고 타입 안전한 접근을 제공하는 공식 OpenAI .NET API 라이브러리입니다.