OpenAI
See leht on masintõlgitud. Vaadake algset ingliskeelset artiklit.

Kuidas saan lisada oma API-kliendi kogukonna teekide lehele?

Kriteeriumid ja sammud, et teie teek oleks valmis lisamiseks meie kogukonna teekide lehele

Värskendatud: 18 days ago

OpenAI haldab lehte Kogukonna teegid, kus loetleme API-kliendid, millega arendajad saavad OpenAI API-t kasutada.

Kui olete loonud avatud lähtekoodiga teegi, mille soovite sellele lehele lisada, siis täname teid! Meil on hea meel näha, et arendajad loovad teistele arendajatele täiendavaid API-tööriistu. Samuti tahame suunata arendajaid heade lahenduste juurde, mis aitavad neil ka pikas perspektiivis edu saavutada. Seetõttu peavad teegid enne meie veebisaidil avaldamist vastama mõnele nõudele.

Veenduge, et vastate alltoodud nõuetele, ja täitke seejärel kogukonna teegi lisamise taotluse vorm.

  1. Standardne avatud lähtekoodi litsents

Loendisse lisamiseks peab kogukonna teek kasutama väheste piirangutega avatud lähtekoodi litsentsi, näiteks MIT-litsentsi. Nii saavad meie kliendid vajaduse korral teeki hõlpsamini kahveldada, kui selle omanikud lõpetavad teegi hooldamise või sellele funktsioonide lisamise.

  1. API-võtmete laadimine keskkonnamuutujate kaudu

README koodinäited peavad julgustama OpenAI API-võtme laadimist keskkonnamuutujate kaudu, mitte selle püsivat lisamist lähtekoodi.

  1. Korrektne ja kvaliteetne kood, mis kajastab API-t täpselt

Koodi peab olema lihtne lugeda ja jälgida ning see peab üldjuhul järgima meie OpenAPI spetsifikatsiooni. Uued teegid ei tohi sisaldada lõpp-punkte, mille juures on selles spetsifikatsioonis märge deprecated: true.

  1. Märkige, et tegu on mitteametliku teegiga

Märkige README algusosas, et tegu on „mitteametliku” või „kogukonna hallatava” teegiga.

  1. Võtke kohustus teeki hooldada

See tähendab eelkõige probleemide lahendamist ning tõmbetaotluste läbivaatamist ja liitmist. Samuti tasub seadistada GitHubi probleemide ja tõmbetaotluste mallid, nagu meie ametlikus Node'i teegis.

Kas sellest artiklist oli abi?