OpenAI
Denne siden ble maskinoversatt. Se den opprinnelige engelske artikkelen.

Hvordan kan jeg legge til API-klienten min på siden for fellesskapsbiblioteker?

Kriterier og trinn for å sikre at biblioteket ditt er klart til å bli lagt til på siden vår for fellesskapsbiblioteker

Oppdatert: 18 days ago

OpenAI har en side for fellesskapsbiblioteker, der vi viser API-klienter utviklere kan bruke for å få tilgang til OpenAI API-et.

Har du laget et åpen kildekode-bibliotek som du ønsker å få oppført på denne siden? Takk! Vi setter stor pris på at utviklere lager flere API-verktøy for andre utviklere. Samtidig vil vi sørge for at vi anbefaler gode løsninger som hjelper utviklere med å lykkes på lang sikt. Derfor stiller vi noen krav før vi oppfører biblioteker på nettstedet vårt.

Kontroller at du oppfyller kriteriene nedenfor, og fyll deretter ut skjemaet for å få et fellesskapsbibliotek oppført.

  1. Standardlisens for åpen kildekode

For å bli oppført må fellesskapsbiblioteker bruke en liberal åpen kildekode-lisens, for eksempel MIT. Da kan kundene våre enklere kopiere biblioteker ved behov dersom eierne slutter å vedlikeholde dem eller legge til funksjoner.

  1. Last inn API-nøkler via miljøvariabler

Kodeeksemplene i README-filen må anbefale å bruke miljøvariabler til å laste inn OpenAI API-nøkkelen, fremfor å hardkode den i kildekoden.

  1. Korrekt kode av høy kvalitet som gjenspeiler API-et nøyaktig

Koden bør være lett å lese og følge, og bør generelt samsvare med OpenAPI-spesifikasjonen vår. Nye biblioteker skal ikke inneholde endepunkter som er merket med deprecated: true i denne spesifikasjonen.

  1. Oppgi at biblioteket er uoffisielt

Oppgi nær toppen av README-filen at dette er et «uoffisielt» eller «fellesskapsvedlikeholdt» bibliotek.

  1. Forplikt deg til å vedlikeholde biblioteket

Dette innebærer først og fremst å håndtere saker samt gjennomgå og slå sammen pull requests. Det kan også være lurt å opprette maler for GitHub-saker og pull requests, slik vi har gjort i det offisielle node-biblioteket vårt.

Var denne artikkelen nyttig?