OpenAI
Эта страница была переведена машинным переводом. Открыть оригинальную статью на английском.

Как добавить мой API-клиент на страницу библиотек сообщества?

Критерии и шаги, чтобы убедиться, что ваша библиотека готова к добавлению на страницу библиотек сообщества

Обновлено: 9 days ago

OpenAI ведёт страницу «Библиотеки сообщества», где перечислены клиенты API, с помощью которых разработчики могут обращаться к API OpenAI.

Если вы создали библиотеку с открытым исходным кодом и хотите добавить её на эту страницу — спасибо! Мы рады, когда разработчики создают дополнительные инструменты для работы с API, которыми могут пользоваться другие разработчики. Мы также хотим рекомендовать разработчикам качественные решения, которые будут приносить пользу в долгосрочной перспективе, поэтому для размещения библиотек на нашем сайте необходимо соответствовать нескольким критериям.

Убедитесь, что ваша библиотека соответствует приведённым ниже критериям, а затем заполните форму запроса на добавление библиотеки сообщества.

  1. Стандартная лицензия с открытым исходным кодом

Для размещения библиотека сообщества должна распространяться по разрешительной лицензии с открытым исходным кодом, например MIT. Это позволит нашим клиентам при необходимости легко выполнить форк библиотеки, если её владельцы перестанут поддерживать её или добавлять новые функции.

  1. Загрузка ключей API через переменные среды

Примеры кода в README должны рекомендовать загружать ключ API OpenAI через переменные среды, а не прописывать его непосредственно в исходном коде.

  1. Корректный и качественный код, точно соответствующий API

Код должен быть понятным и удобным для чтения и в целом соответствовать нашей спецификации OpenAPI. Новые библиотеки не должны включать конечные точки, помеченные в этой спецификации как deprecated: true.

  1. Указание на неофициальный статус библиотеки

В начале файла README укажите, что это «неофициальная» или «поддерживаемая сообществом» библиотека.

  1. Обязательство поддерживать библиотеку

Прежде всего это означает рассмотрение проблем, а также проверку и слияние запросов на включение изменений. Также рекомендуется настроить шаблоны «Проблема GitHub» и PR, как в нашей официальной библиотеке для Node.js.

Была ли эта статья полезной?