OpenAI
Тази страница е машинно преведена. Вижте оригиналната статия на английски език.

Как мога да добавя своя API клиент към страницата Community Libraries?

Критерии и стъпки, за да сте сигурни, че библиотеката ви е готова да бъде добавена към нашата страница Community Libraries

Актуализирано: 18 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.

Беше ли Ви полезна тази статия?