OpenAI
Aquesta pàgina s'ha traduït automàticament. Mostra l'article original en anglès.

Com puc afegir el meu client API a la pàgina de Biblioteques de la comunitat?

Criteris i passos per garantir que la vostra biblioteca estigui a punt per afegir-la a la pàgina de Biblioteques de la comunitat

Actualització: 12 days ago

OpenAI manté una pàgina de biblioteques de la comunitat on enumerem els clients d’API que els desenvolupadors poden utilitzar per accedir a l’API d’OpenAI.

Si heu creat una biblioteca de codi obert que voldríeu afegir a aquesta pàgina, gràcies! Ens encanta que els desenvolupadors creïn més eines d’API per a altres desenvolupadors. També volem assegurar-nos d’orientar els desenvolupadors cap a bones solucions que els permetin tenir èxit a llarg termini. Per això, exigim que les biblioteques compleixin alguns criteris abans d’incloure-les al nostre lloc web.

Assegureu-vos que compliu els criteris següents i, després, empleneu el nostre formulari de sol·licitud per a biblioteques de la comunitat.

  1. Llicència estàndard de codi obert

Per incloure-les, exigim que les biblioteques de la comunitat utilitzin una llicència permissiva de codi obert, com ara la MIT. Això permet als nostres clients bifurcar les biblioteques més fàcilment si cal, en cas que els propietaris deixin de mantenir-les o d’afegir-hi funcions.

  1. Carregueu les claus de l’API mitjançant variables d’entorn

Els exemples de codi del README han de fomentar l’ús de variables d’entorn per carregar la clau de l’API d’OpenAI, en lloc d’incloure-la directament al codi font.

  1. Codi correcte i d’alta qualitat que reflecteixi fidelment l’API

El codi ha de ser fàcil de llegir i seguir i, en general, ha de complir la nostra especificació d’OpenAPI. Les biblioteques noves no han d’incloure punts d’accés marcats com a deprecated: true en aquesta especificació.

  1. Indiqueu que és una biblioteca no oficial

Indiqueu en algun lloc prop de l’inici del README que és una biblioteca "no oficial" o "mantinguda per la comunitat".

  1. Comprometeu-vos a mantenir la biblioteca

Això vol dir, principalment, resoldre incidències i revisar i fusionar sol·licituds d’incorporació. També pot ser útil configurar plantilles d’elements de seguiment de GitHub i de sol·licituds d’incorporació, com les de la nostra biblioteca oficial de node.

T'ha estat útil aquest article?