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

OpenAI utrzymuje stronę Biblioteki Społeczności, na której wymieniamy klientów API, z których deweloperzy mogą korzystać, aby uzyskać dostęp do interfejsu API OpenAI.

Jeśli stworzył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 pomogą im odnieść długoterminowy sukces, dlatego wymagamy spełnienia kilku kryteriów, zanim umieścimy biblioteki na naszej stronie.

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

  1. Standardowa licencja open source
    Aby znaleźć się na liście, wymagamy, aby 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ć nowe funkcje.

  2. Ładuj klucze 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.

  3. Poprawny kod wysokiej jakości, który wiernie odzwierciedla API
    Kod powinien być łatwy do czytania i śledzenia oraz zasadniczo powinien być zgodny z naszą specyfikacją OpenAPI – nowe biblioteki nie powinny zawierać punktów końcowych oznaczonych w tej specyfikacji jako deprecated: true.

  4. Zaznacz, że to nieoficjalna biblioteka
    Podaj gdzieś w górnej części pliku README, że jest to biblioteka „nieoficjalna” lub „utrzymywana przez społeczność”.

  5. Zobowiąż się do utrzymywania biblioteki
    Oznacza to przede wszystkim rozwiązywanie zgłoszonych problemów oraz przeglądanie i scalanie żądań pull request. Dobrym pomysłem może też być skonfigurowanie szablonów zgłoszeń GitHub Issues i PR, podobnych do tych, które mamy w naszej oficjalnej bibliotece node.

Czy ten artykuł był pomocny?