OpenAI
Tämä sivu on konekäännetty. Katso alkuperäinen englanninkielinen artikkeli.

Miten voin lisätä API-asiakasohjelmani Community Libraries -sivulle?

Vaatimukset ja vaiheet, joilla varmistat, että kirjastosi voidaan lisätä Community Libraries -sivullemme

Päivitetty: 21 days ago

OpenAI ylläpitää Community Libraries -sivua, jolla luettelemme API-asiakasohjelmia, joita kehittäjät voivat käyttää OpenAI API:n käyttämiseen.

Jos olet rakentanut avoimen lähdekoodin kirjaston, jonka haluaisit lisättävän tälle sivulle – kiitos! Meistä on hienoa nähdä kehittäjien rakentavan lisää API-työkaluja muille kehittäjille. Haluamme myös varmistaa, että ohjaamme kehittäjiä hyviin ratkaisuihin, jotka auttavat heitä menestymään pitkällä aikavälillä, joten meillä on muutamia vaatimuksia, joiden on täytyttävä ennen kuin listaamme kirjastoja verkkosivustollamme.

Varmistathan, että täytät alla luetellut vaatimukset, ja täytä sitten Community Libraries -pyyntölomake.

  1. Vakiomuotoinen avoimen lähdekoodin lisenssi
    Jotta kirjasto voidaan listata, edellytämme, että yhteisökirjastoissa käytetään sallivaa avoimen lähdekoodin lisenssiä, kuten MIT-lisenssiä. Tämä antaa asiakkaillemme mahdollisuuden helpommin tehdä kirjastoista haaroitus tarvittaessa, jos omistajat lakkaavat ylläpitämästä niitä tai lisäämästä ominaisuuksia.

  2. Lataa API-avaimet ympäristömuuttujien kautta
    README-tiedoston koodiesimerkkien on ohjattava käyttämään ympäristömuuttujia OpenAI API -avaimen lataamiseen sen sijaan, että se kovakoodattaisiin lähdekoodiin.

  3. Oikea, korkealaatuinen koodi, joka vastaa tarkasti API:a
    Koodin tulisi olla helppolukuista ja helposti seurattavaa, ja sen tulisi yleisesti noudattaa OpenAPI-määritystämme – uusien kirjastojen ei pidä sisältää endpointteja, jotka on merkitty tässä määrityksessä muodossa deprecated: true.

  4. Ilmoita, että kyseessä on epävirallinen kirjasto
    Mainitse jossakin README-tiedoston alussa, että kyseessä on ”epävirallinen” tai ”yhteisön ylläpitämä” kirjasto.

  5. Sitoudu ylläpitämään kirjastoa
    Tämä tarkoittaa ennen kaikkea ongelmien käsittelyä sekä muutospyyntöjen tarkistamista ja yhdistämistä. Voi myös olla hyvä idea ottaa käyttöön Github Issue- ja PR-mallit, kuten meillä on virallisessa node-kirjastossamme.

Oliko tästä artikkelista apua?