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: 7 days ago

OpenAI prowadzi stronę Biblioteki społeczności, na której wymieniamy klientów API, których deweloperzy mogą używać do uzyskiwania dostępu do API OpenAI.

Jeśli zbudowałeś bibliotekę open source, którą chcesz dodać do tej strony — dziękujemy! Cieszy nas, gdy deweloperzy tworzą dodatkowe narzędzia API dla innych deweloperów. Chcemy też mieć pewność, że kierujemy deweloperów do dobrych rozwiązań, które zapewnią im długoterminowy sukces, dlatego przed umieszczeniem bibliotek w naszej witrynie wymagamy spełnienia kilku kryteriów.

Upewnij się, że spełniasz kryteria wymienione poniżej, a następnie wypełnij nasz formularz zgłoszeniowy Bibliotek społeczności.

  1. Standardowa licencja open source

Aby biblioteka została umieszczona na liście, wymagamy, by biblioteki społeczności korzystały z permisywnej licencji open source, takiej jak MIT. Dzięki temu nasi klienci mogą w razie potrzeby łatwiej forkować biblioteki, jeśli ich właściciele przestaną je utrzymywać lub dodawać funkcje.

  1. Ładowanie kluczy API przez zmienne środowiskowe

Przykłady kodu w pliku README muszą zachęcać do używania zmiennych środowiskowych do ładowania klucza API OpenAI zamiast wpisywania go na stałe w kodzie źródłowym.

  1. Poprawny, wysokiej jakości kod, który dokładnie odzwierciedla API

Kod powinien być łatwy do czytania i śledzenia oraz zasadniczo zgodny z naszą specyfikacją OpenAPI — nowe biblioteki nie powinny uwzględniać punktów końcowych oznaczonych w tej specyfikacji jako deprecated: true.

  1. Podaj, że jest to biblioteka nieoficjalna

Podaj gdzieś na początku pliku README, że jest to biblioteka „nieoficjalna” lub „utrzymywana przez społeczność”.

  1. Zobowiąż się do utrzymywania biblioteki

Oznacza to przede wszystkim rozwiązywanie problemów oraz przeglądanie i scalanie żądań pull request. Dobrym pomysłem może być też skonfigurowanie szablonów Github Issue i PR, takich jak te w naszej oficjalnej bibliotece node.

Czy ten artykuł był pomocny?