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

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

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

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

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

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

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

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

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

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

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

  1. کد درست و باکیفیت که API را به‌دقت بازتاب می‌دهد

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

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

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

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

این عمدتاً به معنای رسیدگی به مسائل و بررسی و ادغام درخواست‌های نظرسنجی است. همچنین می‌تواند ایده خوبی باشد که الگوهای Issue و PR در Github را مانند آنچه در کتابخانه رسمی گره ما وجود دارد، تنظیم کنید.

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