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

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

Kriterien und Schritte, um sicherzustellen, dass Ihre Bibliothek bereit ist, zu unserer Seite „Community Libraries“ hinzugefügt zu werden

Aktualisiert: 13 days ago

OpenAI betreibt eine Seite Community Libraries, auf der wir API-Clients auflisten, die Entwickler nutzen können, um auf die OpenAI API zuzugreifen.

Wenn Sie eine Open-Source-Bibliothek erstellt haben, die Sie auf dieser Seite hinzufügen lassen möchten – vielen Dank! Wir freuen uns, wenn Entwickler zusätzliche API-Tools für andere Entwickler bauen. Wir möchten außerdem sicherstellen, dass wir Entwickler zu guten Lösungen führen, mit denen sie langfristig erfolgreich sind. Daher haben wir einige Kriterien, die wir erfüllen lassen, bevor wir Bibliotheken auf unserer Website auflisten.

Bitte stellen Sie sicher, dass Sie die unten aufgeführten Kriterien erfüllen, und füllen Sie anschließend unser Anfrageformular für Community Libraries aus.

  1. Standard-Open-Source-Lizenz
    Um gelistet zu werden, verlangen wir, dass Community-Bibliotheken eine permissive Open-Source-Lizenz wie MIT verwenden. So können unsere Kunden Bibliotheken bei Bedarf leichter forken, falls die Eigentümer die Pflege einstellen oder keine neuen Funktionen mehr hinzufügen.

  2. API-Schlüssel über Umgebungsvariablen laden
    Codebeispiele in der README müssen die Nutzung von Umgebungsvariablen zum Laden des OpenAI-API-Schlüssels fördern, statt ihn im Quellcode fest zu hinterlegen.

  3. Korrekte, hochwertige Codebasis, die die API präzise abbildet
    Der Code sollte leicht zu lesen/nachzuvollziehen sein und sich im Allgemeinen an unsere OpenAPI-Spezifikation halten – neue Bibliotheken sollten keine Endpunkte enthalten, die in dieser Spezifikation als deprecated: true markiert sind.

  4. Hinweis, dass es sich um eine inoffizielle Bibliothek handelt
    Bitte geben Sie irgendwo nahe am Anfang Ihrer README an, dass es sich um eine „inoffizielle“ oder „von der Community gepflegte“ Bibliothek handelt.

  5. Verpflichtung zur Pflege der Bibliothek
    Das bedeutet vor allem, Issues zu bearbeiten sowie Pull Requests zu prüfen und zusammenzuführen. Es kann außerdem sinnvoll sein, GitHub-Issue- & PR-Templates einzurichten – so wie wir es in unserer offiziellen Node-Bibliothek haben.

War dieser Artikel hilfreich?