OpenAI
Для перекладу цієї сторінки виконано машинний переклад. Ви можете переглянути оригінальну статтю англійською.

Як додати мій API-клієнт на сторінку Community Libraries?

Критерії та кроки, щоб ваша бібліотека була готова до додавання на сторінку Community Libraries

Оновлено: 11 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.

Чи була ця стаття корисною?