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: 8 days ago

OpenAI vzdržuje stran Knjižnice skupnosti, kjer navajamo odjemalce API, ki jih lahko razvijalci uporabljajo za dostop do API-ja OpenAI.

Če ste razvili odprtokodno knjižnico, ki bi jo radi dodali na to stran – hvala! Veseli nas, ko razvijalci ustvarjajo dodatna orodja API za druge razvijalce. Prav tako želimo poskrbeti, da razvijalce usmerjamo k dobrim rešitvam, ki jim bodo dolgoročno pomagale do uspeha, zato imamo nekaj meril, ki jih morajo knjižnice izpolnjevati, preden jih uvrstimo na svoje spletno mesto.

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

  1. Standardna odprtokodna licenca

Za uvrstitev zahtevamo, da knjižnice skupnosti uporabljajo dovoljeno odprtokodno licenco, kot je MIT. To našim strankam omogoča, da po potrebi lažje osamijo knjižnice, če jih lastniki prenehajo vzdrževati ali jim dodajati funkcije.

  1. Nalaganje ključev API prek spremenljivk okolja

Primeri kode v datoteki README morajo spodbujati uporabo spremenljivk okolja za nalaganje ključa API OpenAI, namesto da bi bil ta trdo kodiran v izvorni kodi.

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

Koda mora biti lahko berljiva in ji mora biti lahko slediti, na splošno pa mora 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. Navedite, da gre za neuradno knjižnico

Nekje pri vrhu datoteke README navedite, da je knjižnica »neuradna« ali »jo vzdržuje skupnost«.

  1. Zavežite se k vzdrževanju knjižnice

To predvsem pomeni obravnavanje težav ter pregledovanje in združevanje zahtev za združitev sprememb. Dobra zamisel je lahko tudi, da nastavite predloge za GitHub Issue in PR, kot jih imamo v naši uradni knjižnici Node.

Ali vam je bil ta članek v pomoč?