OpenAI
Ta strona została przetłumaczona maszynowo. Wyświetl oryginalny artykuł w języku angielskim.

Jak mogę dodać mojego klienta API do strony Bibliotek Społeczności?

Kryteria i kroki, które zapewnią, że Twoja biblioteka jest gotowa do dodania do naszej strony Bibliotek Społeczności

Zaktualizowano: 15 days ago

OpenAI prowadzi stronę Biblioteki społeczności, na której zamieszczamy listę klientów API umożliwiających deweloperom dostęp do API OpenAI.

Jeśli masz bibliotekę open source, którą chcesz dodać do tej strony — dziękujemy! Cieszymy się, gdy deweloperzy tworzą dodatkowe narzędzia API dla innych deweloperów. Chcemy również polecać deweloperom dobre rozwiązania, które zapewnią im długofalowy sukces. Dlatego przed umieszczeniem bibliotek w naszej witrynie wymagamy spełnienia kilku kryteriów.

Upewnij się, że spełniasz poniższe kryteria, a następnie wypełnij formularz zgłoszenia biblioteki społeczności.

  1. Standardowa licencja open source

Aby znaleźć się na liście, biblioteka społeczności musi korzystać z liberalnej licencji open source, takiej jak MIT. Dzięki temu nasi klienci mogą w razie potrzeby łatwiej zastosować „fork” do bibliotek, jeśli ich właściciele przestaną je rozwijać lub dodawać nowe funkcje.

  1. Wczytywanie kluczy API ze zmiennych środowiskowych

Przykłady kodu w pliku README muszą zachęcać do wczytywania klucza API OpenAI ze zmiennych środowiskowych zamiast umieszczania go bezpośrednio w kodzie źródłowym.

  1. Poprawny kod wysokiej jakości, dokładnie odzwierciedlający API

Kod powinien być czytelny i łatwy do zrozumienia oraz zasadniczo zgodny z naszą specyfikacją OpenAPI. Nowe biblioteki nie powinny zawierać punktów końcowych oznaczonych w tej specyfikacji jako deprecated: true.

  1. Informacja, że biblioteka jest nieoficjalna

W górnej części pliku README umieść informację, że jest to biblioteka „nieoficjalna” lub „utrzymywana przez społeczność”.

  1. Zobowiązanie do utrzymywania biblioteki

Oznacza to przede wszystkim reagowanie na zgłoszenia oraz przeglądanie i scalanie pull requestów. Warto również skonfigurować szablony zgłoszeń GitHub i pull requestów, podobne do tych w naszej oficjalnej bibliotece dla Node.js.

Czy ten artykuł był pomocny?