OpenAI
Halaman ini diterjemah oleh mesin. Lihat artikel asal dalam bahasa Inggeris.

Bagaimanakah saya boleh menambahkan klien API saya pada halaman Perpustakaan Komuniti?

Kriteria dan langkah untuk memastikan pustaka anda sedia ditambahkan pada halaman Perpustakaan Komuniti kami

Dikemas kini: 9 days ago

OpenAI menyelenggara halaman Perpustakaan Komuniti yang menyenaraikan klien API yang boleh digunakan oleh pembangun untuk mengakses API OpenAI.

Jika anda telah membina pustaka sumber terbuka yang ingin ditambahkan pada halaman ini – terima kasih! Kami gembira melihat pembangun membina alat API tambahan untuk pembangun lain. Kami juga mahu memastikan kami mengarahkan pembangun kepada penyelesaian yang baik dan membantu mereka berjaya untuk jangka panjang, jadi kami mempunyai beberapa kriteria yang perlu dipenuhi sebelum kami menyenaraikan pustaka di laman web kami.

Sila pastikan anda memenuhi kriteria yang disenaraikan di bawah, kemudian isi borang permintaan Perpustakaan Komuniti kami.

  1. Lesen sumber terbuka standard

Untuk disenaraikan, kami mensyaratkan pustaka komuniti menggunakan lesen sumber terbuka permisif seperti MIT. Ini membolehkan pelanggan kami melakukan fork pustaka dengan lebih mudah jika perlu, sekiranya pemilik berhenti menyelenggara atau menambah ciri padanya.

  1. Muatkan kunci API melalui pemboleh ubah persekitaran

Contoh kod dalam README mesti menggalakkan penggunaan pemboleh ubah persekitaran untuk memuatkan kunci API OpenAI, dan bukannya mengekodkannya secara tetap dalam kod sumber.

  1. Kod yang betul dan berkualiti tinggi serta mencerminkan API dengan tepat

Kod hendaklah mudah dibaca/diikuti, dan secara amnya harus mematuhi spesifikasi OpenAPI kami – pustaka baharu tidak sepatutnya menyertakan titik akhir yang ditandakan sebagai deprecated: true dalam spesifikasi ini.

  1. Nyatakan bahawa ia pustaka tidak rasmi

Sila nyatakan di suatu tempat berhampiran bahagian atas README anda bahawa ia ialah pustaka “tidak rasmi” atau “diselenggara komuniti”.

  1. Berikan komitmen untuk menyelenggara pustaka

Ini terutamanya bermaksud menangani isu serta menyemak dan menggabungkan pull request. Anda juga boleh mempertimbangkan untuk menyediakan templat Issue & PR GitHub seperti yang kami gunakan dalam pustaka Node rasmi kami.

Adakah artikel ini membantu?