OpenAI
Diese Seite wurde maschinell übersetzt. Den Originalartikel auf Englisch ansehen.

Wie kann ich meinen API-Client zur Seite „Community-Bibliotheken“ hinzufügen?

Kriterien und Schritte, damit deine Bibliothek für die Aufnahme auf unserer Seite „Community-Bibliotheken“ bereit ist

Aktualisiert: last month

OpenAI betreibt eine Seite zu Community-Bibliotheken. Dort führen wir API-Clients auf, mit denen Entwicklungsteams auf die OpenAI API zugreifen können.

Wenn du eine Open-Source-Bibliothek entwickelt hast, die du gern auf dieser Seite ergänzen möchtest: Vielen Dank! Wir freuen uns, wenn Entwicklungsteams zusätzliche API-Werkzeuge für andere entwickeln. Zugleich möchten wir Entwicklungsteams verlässliche Lösungen empfehlen, mit denen sie langfristig erfolgreich arbeiten können. Deshalb müssen Bibliotheken einige Kriterien erfüllen, bevor wir sie auf unserer Website aufführen.

Vergewissere dich bitte, dass du die unten aufgeführten Kriterien erfüllst, und fülle anschließend unser Antragsformular für Community-Bibliotheken aus.

  1. Standardmäßige Open-Source-Lizenz

Damit wir eine Community-Bibliothek aufführen können, muss sie eine freizügige Open-Source-Lizenz wie MIT verwenden. So können unsere Kunden Bibliotheken bei Bedarf leichter forken, falls die Verantwortlichen die Pflege oder Weiterentwicklung einstellen.

  1. API-Schlüssel über Umgebungsvariablen laden

Codebeispiele in der README müssen dazu anregen, den OpenAI-API-Schlüssel über Umgebungsvariablen zu laden, statt ihn fest im Quellcode zu hinterlegen.

  1. Korrekter, hochwertiger Code, der die API präzise abbildet

Der Code sollte leicht lesbar und nachvollziehbar sein und grundsätzlich unserer OpenAPI-Spezifikation entsprechen. Neue Bibliotheken dürfen keine Endpunkte enthalten, die in dieser Spezifikation mit deprecated: true gekennzeichnet sind.

  1. Als inoffizielle Bibliothek kennzeichnen

Gib bitte weit oben in deiner README an, dass es sich um eine „inoffizielle“ oder „von der Community gepflegte“ Bibliothek handelt.

  1. Zur Pflege der Bibliothek verpflichten

Das bedeutet vor allem, Issues zu bearbeiten sowie Pull Requests zu prüfen und zusammenzuführen. Außerdem kann es sinnvoll sein, Vorlagen für GitHub-Issues und PRs einzurichten, wie wir sie in unserer offiziellen Node-Bibliothek verwenden.

War dieser Artikel hilfreich?