OpenAI
این صفحه به‌صورت ماشینی ترجمه شده است. مقاله اصلی انگلیسی را مشاهده کنید.

چطور می‌توانم کلاینت API خود را به صفحه کتابخانه‌های جامعه اضافه کنم؟

معیارها و مراحل لازم برای اطمینان از آماده بودن کتابخانه شما برای افزوده شدن به صفحه کتابخانه‌های جامعه

به‌روزرسانی: 4 days ago

OpenAI صفحه‌ای با عنوان کتابخانه‌های جامعه توسعه‌دهندگان دارد که در آن کلاینت‌های API قابل استفاده برای دسترسی به API‏ OpenAI را فهرست می‌کنیم.

اگر کتابخانه‌ای متن‌باز ساخته‌اید و مایلید به این صفحه اضافه شود، از شما متشکریم! از اینکه توسعه‌دهندگان ابزارهای بیشتری برای کار با API می‌سازند تا دیگر توسعه‌دهندگان از آن‌ها استفاده کنند، استقبال می‌کنیم. همچنین می‌خواهیم توسعه‌دهندگان را به‌سوی راهکارهای مناسبی هدایت کنیم که در بلندمدت به موفقیتشان کمک می‌کنند؛ بنابراین برای درج کتابخانه‌ها در وب‌سایتمان چند معیار داریم.

لطفاً مطمئن شوید معیارهای زیر را دارید و سپس فرم درخواست کتابخانه‌های جامعه توسعه‌دهندگان را تکمیل کنید.

  1. مجوز استاندارد متن‌باز

برای درج در فهرست، کتابخانه‌های جامعه توسعه‌دهندگان باید از یک مجوز متن‌باز سهل‌گیرانه مانند MIT استفاده کنند. این کار به مشتریان ما امکان می‌دهد اگر مالکان کتابخانه نگهداری یا افزودن قابلیت‌ها را متوقف کردند، در صورت لزوم آن را آسان‌تر فورک کنند.

  1. بارگذاری کلیدهای API از طریق متغیرهای محیطی

نمونه‌کدهای README باید به‌جای ثبت مستقیم کلید API‏ OpenAI در کد منبع، استفاده از متغیرهای محیطی را برای بارگذاری آن توصیه کنند.

  1. کد صحیح و باکیفیتی که API را دقیق بازتاب دهد

کد باید خواندن و دنبال‌کردن آسانی داشته باشد و در مجموع با مشخصات OpenAPI ما مطابقت کند؛ کتابخانه‌های جدید نباید نقاط پایانی علامت‌گذاری‌شده با deprecated: true در این مشخصات را شامل شوند.

  1. اعلام غیررسمی‌بودن کتابخانه

لطفاً در بخش بالایی README ذکر کنید که این کتابخانه «غیررسمی» یا «تحت نگهداری جامعه توسعه‌دهندگان» است.

  1. تعهد به نگهداری کتابخانه

این کار عمدتاً به‌معنای رسیدگی به مشکلات و بررسی و ادغام درخواست‌های pull است. همچنین بهتر است مانند کتابخانه رسمی Node ما، الگوهایی برای مشکل GitHub و درخواست pull تنظیم کنید.

آیا این مقاله مفید بود؟