OpenAI
Ta stran je bila strojno prevedena. Oglejte si izvirni članek v angleščini.

Kako lahko dodam svojega odjemalca API na stran knjižnic skupnosti?

Merila in koraki za zagotovitev, da je vaša knjižnica pripravljena za dodajanje na našo stran Knjižnice skupnosti

Posodobljeno: 18 days ago

OpenAI vzdržuje stran Knjižnice skupnosti, na kateri so navedeni odjemalci API, s katerimi lahko razvijalci dostopajo do API-ja OpenAI.

Če ste ustvarili odprtokodno knjižnico, ki bi jo želeli dodati na to stran, se vam zahvaljujemo! Veseli nas, ko razvijalci ustvarjajo dodatna orodja API za druge razvijalce. Razvijalce želimo usmerjati tudi k dobrim rešitvam, ki jim bodo dolgoročno omogočale uspeh, zato morajo knjižnice pred objavo na našem spletnem mestu izpolnjevati nekaj meril.

Prepričajte se, da izpolnjujete spodaj navedena merila, nato pa izpolnite naš obrazec za vključitev knjižnice skupnosti.

  1. Standardna odprtokodna licenca

Za uvrstitev na seznam morajo knjižnice skupnosti uporabljati permisivno odprtokodno licenco, kot je MIT. Tako lahko naše stranke knjižnice po potrebi lažje osamijo, če jih lastniki prenehajo vzdrževati ali jim dodajati funkcije.

  1. Nalaganje ključev API prek okoljskih spremenljivk

Primeri kode v datoteki README morajo spodbujati uporabo okoljskih spremenljivk za nalaganje ključa API OpenAI namesto njegove neposredne vključitve v izvorno kodo.

  1. Pravilna in kakovostna koda, ki natančno odraža API

Koda mora biti lahko berljiva in razumljiva ter mora praviloma upoštevati našo specifikacijo OpenAPI. Nove knjižnice ne smejo vključevati končnih točk, ki so v tej specifikaciji označene kot deprecated: true.

  1. Navedba, da je knjižnica neuradna

Nekje pri vrhu datoteke README navedite, da gre za »neuradno« knjižnico ali »knjižnico, ki jo vzdržuje skupnost«.

  1. Zaveza k vzdrževanju knjižnice

To pomeni predvsem obravnavanje zadev ter pregledovanje in združevanje zahtev za vključitev sprememb. Priporočljivo je tudi nastaviti predloge za Zadeve GitHub in zahteve za vključitev sprememb, kot jih imamo v naši uradni knjižnici za Node.js.

Ali vam je bil ta članek v pomoč?