apihub
v1.3.0
Kami mencoba membangun hub API sumber tunggal yang dapat digunakan untuk mempelajari penanganan API dalam bahasa pemrograman apa pun. Pengguna dapat membangun portofolio ujung depan mereka di aplikasi web dan seluler menggunakan hub API ini.
Proyek FreeAPi adalah inisiatif inovatif dan berbasis masyarakat yang bertujuan memberikan API gratis dan dapat diakses kepada pengembang untuk proyek mereka.
Proyek ini berfokus pada memberikan berbagai macam API yang melayani berbagai domain dan fungsionalitas, memungkinkan pengembang untuk mengintegrasikan API ini dengan mulus ke dalam aplikasi mereka.
Sorotan utama dari proyek FreeAPi meliputi:
Aksesibilitas: Proyek Freeasi berkomitmen untuk menghilangkan hambatan dengan memberikan akses gratis ke koleksi API. Pengembang dapat memanfaatkan API ini tanpa batasan biaya, memungkinkan mereka untuk bereksperimen, belajar, dan membangun aplikasi inovatif.
Koleksi API yang beragam: Proyek ini menawarkan koleksi API yang beragam dan komprehensif yang membentang di berbagai industri, domain, dan fungsionalitas. Apakah Anda memerlukan integrasi media sosial, gateway pembayaran, algoritma pembelajaran mesin, atau konektivitas perangkat IoT, proyek FreePi telah Anda liput.
Integrasi Sederhana: Proyek FreeApi memahami tantangan yang dihadapi pengembang saat mengintegrasikan API ke dalam aplikasi mereka. Untuk mengatasi hal ini, proyek ini memberikan dokumentasi yang jelas, sampel kode, dan SDK, menyederhanakan proses integrasi dan mengurangi waktu dan upaya pengembangan.
Pengembangan yang digerakkan oleh masyarakat: Proyek ini mendorong komunitas pengembang yang bersemangat dan kolaboratif. Kontributor didorong untuk berbagi pengetahuan mereka, terlibat dalam diskusi, dan berkolaborasi pada proyek terkait API. Upaya kolektif ini memastikan peningkatan berkelanjutan dan keandalan API yang ditawarkan oleh proyek FREEPI.
Pengembangan Pembelajaran dan Keterampilan: Proyek Freeasi bertujuan untuk memberdayakan pengembang dengan menyediakan platform untuk belajar dan pengembangan keterampilan. Melalui akses ke berbagai sumber daya API dan pendidikan, pengembang dapat meningkatkan pemahaman mereka tentang integrasi API, memperluas pengetahuan mereka, dan menunjukkan keahlian mereka melalui membangun proyek lengkap.
Secara keseluruhan, proyek FreeApi adalah sumber yang berharga bagi pengembang yang mencari API yang dapat diakses dan beragam.
Dengan menumbuhkan komunitas yang mendukung, proyek ini memberdayakan pengembang untuk belajar, menciptakan, dan berinovasi, pada akhirnya berkontribusi pada pertumbuhan dan kemajuan lanskap integrasi API.
Memperkenalkan Proyek API Hub Open Source kami yang inovatif, platform dinamis yang dirancang untuk merevolusi cara pengembang berinteraksi dengan API.
Dengan penekanan pada keterbukaan, aksesibilitas, dan pembelajaran, Hub API kami memberdayakan pengembang dari semua tingkatan untuk mengeksplorasi, bereksperimen, dan menumbuhkan keterampilan mereka dalam integrasi API.
Highlight:
Open Source: Hub API kami dibangun di atas prinsip-prinsip open source, memastikan transparansi, kolaborasi, dan pengembangan yang digerakkan oleh masyarakat. Ini berarti bahwa kode sumber tersedia secara bebas, memungkinkan pengembang untuk menyesuaikan, memperluas, dan berkontribusi pada proyek.
Gratis untuk digunakan: Kami sangat percaya menghilangkan hambatan untuk masuk, itulah sebabnya hub API kami benar -benar bebas digunakan. Apakah Anda seorang pengembang berpengalaman atau baru memulai perjalanan pengkodean Anda, Anda dapat memanfaatkan platform kami tanpa batasan biaya.
Lokal atau Penempatan : Fleksibilitas adalah inti dari hub API kami. Anda memiliki opsi untuk menggunakannya secara lokal, berjalan di mesin Anda sendiri, atau menggunakannya ke server, membuatnya dapat diakses oleh orang lain. Fleksibilitas ini memastikan bahwa Anda dapat menyesuaikan platform dengan lingkungan pengembangan spesifik Anda.
Sumber Belajar : Hub API kami dirancang sebagai sumber belajar yang komprehensif, menawarkan banyak materi pendidikan, tutorial, dan dokumentasi. Apakah Anda seorang pemula atau berusaha memperluas pengetahuan API Anda, platform kami menyediakan sumber daya yang perlu Anda pelajari dan tingkatkan.
Titik akhir khusus untuk pemula : Untuk pengembang di tingkat pemula, API Hub kami menawarkan titik akhir khusus yang memberikan pengalaman langsung dalam menangani tanggapan API. API yang ramah-pemula ini memungkinkan Anda untuk berlatih dan membiasakan diri dengan dasar-dasar bekerja dengan API.
API Advanced for Portofolio : Selain titik akhir tingkat pemula, API Hub kami juga menyediakan API canggih untuk menantang dan memperluas keterampilan Anda. API ini memungkinkan Anda untuk menangani skenario integrasi yang lebih kompleks, membantu Anda membangun portofolio proyek yang kuat untuk menunjukkan keahlian Anda.
Dengan menggabungkan prinsip -prinsip open source, aksesibilitas, dan fokus pada pembelajaran, proyek API Hub kami membuka jalan bagi pengembang untuk berkembang di dunia integrasi API. Bergabunglah dengan komunitas kami yang bersemangat dan memulai perjalanan penemuan, pertumbuhan, dan inovasi yang menyenangkan.
Proyek open-source kami saat ini di-host di server jarak jauh, di mana kami dipaksa untuk mengatur ulang seluruh server, termasuk sistem file dan database MongoDB , setiap 2 jam untuk menghindari mengeluarkan biaya tambahan.
Proses ini menghasilkan penghapusan semua file gambar/statis dan reset dari seluruh database di server.
Kehilangan data: Setiap perubahan yang dilakukan selama interval 2 jam (pada server jarak jauh), termasuk gambar yang diunggah dan data pengguna, akan hilang dan tidak dapat dipulihkan.
Gangguan Layanan: Reset server mungkin mengganggu proses pengembangan dan pengujian Anda untuk durasi tertentu saat server sedang reboot (selama 1-2 menit).
Penggunaan API Lokal: Untuk tujuan pengembangan dan pengujian, kami sangat menyarankan menggunakan API secara lokal di mesin Anda dengan mengkloning proyek .
Ini memastikan bahwa pekerjaan Anda tidak terpengaruh oleh server yang diatur ulang dan memungkinkan Anda untuk mempertahankan lingkungan pengembangan yang stabil di mesin lokal Anda.
Hosting sendiri di kereta api (direkomendasikan untuk proyek pribadi) : Untuk menjadi tuan rumah sendiri aplikasi FreeAPi.app, Anda dapat memanfaatkan template pra-dibangun yang sudah tersedia. Klik di sini untuk dokumen terperinci
Untuk menjalankan proyek FreeApi, ikuti langkah -langkah ini:
.env di folder root dan salin tempel konten .env.sample , dan tambahkan kredensial yang diperlukan.docker-compose up --build --attach backend
# --build: Rebuild the image and run the containers
# --attach: only show logs of Node app container and not mongodbUntuk menjalankan Proyek Freeasi secara lokal, ikuti langkah -langkah ini:
.env di folder root dan salin tempel konten .env.sample , dan tambahkan kredensial yang diperlukan.yarn installyarn startUntuk menjadi tuan rumah sendiri aplikasi FreeAPi.App, Anda dapat memanfaatkan template yang sudah dibangun yang sudah tersedia.
Klik tombol di atas untuk mengunjungi Railway.app.
Klik tombol Deploy Now .
(Opsional) Masuk dengan GitHub untuk digunakan.
Isi detail repositori:
Untuk variabel lingkungan, kami telah memberikan beberapa nilai default dalam ENV untuk mengurangi beban, tetapi beberapa parameter wajib:
PORT : Jangan ubah nilainya, biarkan diatur ke 8080 untuk melihat dokumen Swagger setelah penempatan.MONGODB_URI : Menyediakan URL database Atlas MongoDB. Contoh lebih disukai untuk Anda, edit/perbarui untuk melanjutkan.NODE_ENV : Default diatur ke 'pengembangan' untuk melihat log. Anda dapat memilih untuk mengubahnya menjadi 'produksi' (pastikan untuk menambahkan kata yang sama persis) untuk menyembunyikannya.EXPRESS_SESSION_SECRET : disarankan untuk mengubah nilai default ke nilai rahasia Anda sendiri.ACCESS_TOKEN_SECRET : Disarankan untuk mengubah nilai default ke nilai rahasia Anda sendiri.ACCESS_TOKEN_EXPIRY : diatur ke 1 hari sebagai default.REFRESH_TOKEN_SECRET : Disarankan untuk mengubah nilai default ke nilai rahasia Anda sendiri.REFRESH_TOKEN_EXPIRY : diatur ke 10 hari sebagai default.FREEAPI_HOST_URL : atur sebagai url kereta api yang dihasilkan.Setelah Anda mengisi parameter lingkungan yang diperlukan, jika Anda memilih untuk menambahkan orang lain seperti PayPal, Google, dan Razorpay, silakan sebutkan kredensial Anda dalam formulir.
Klik tombol Deploy untuk memicu build pertama.
Catatan: Setelah aplikasi digunakan, harap tunggu selama 3-5 menit agar dokumen Swagger tersedia.
Untuk memastikan keandalan & stabilitas bagi pengguna akhir kami, kami menggunakan penulis naskah, kerangka pengujian yang kuat untuk mengotomatisasi pengujian di semua titik akhir.
Pastikan untuk menambahkan MONGO_MEMORY_SERVER_PORT=10000 (port mongoDB untuk pengujian e2e) di file .env Anda.
yarn start:test-serveryarn test:playwrightIni akan menghasilkan laporan penulis naskah. Untuk melihat laporan ini jalankan perintah berikut
yarn playwright show-reportPastikan semua kasus uji dilewati setiap kali Anda melakukan perubahan.
Kami menyambut minat Anda untuk berkontribusi pada proyek open source kami!
Untuk berkontribusi pada Freeasi, silakan ikuti langkah -langkah ini:
git checkout -b feat/your-feature-name atau git checkout -b fix/your-bug-fix-name dan buat perubahan Anda.git commit -am 'add your commit message'git push origin feat/your-feature-name .Berikut panduan tentang bagaimana Anda dapat berkontribusi secara efektif ke Hub API kami:
Tarik Permintaan untuk Pembaruan README: Harap jangan mengirim permintaan tarik semata -mata untuk memperbarui file ReadMe proyek. Meskipun kami menghargai pentingnya dokumentasi yang jelas dan ringkas, kami lebih suka fokus pada kontribusi kode substansial dan peningkatan fitur.
Pembaruan Tata Bahasa: Tim kami menghargai komunikasi yang efektif, tetapi kami bukan tata bahasa. Anda tidak perlu mengirim permintaan tarik semata -mata untuk perbaikan tata bahasa atau perbaikan bahasa kecil. Sebaliknya, berkonsentrasi pada fungsionalitas inti dan fitur proyek.
Hindari memperbarui API publik yang ada: Untuk menjaga stabilitas dan konsistensi, kami mencegah pembaruan langsung ke API publik yang ada di dalam hub API. API ini telah diuji dan disetujui secara menyeluruh. Namun, jika Anda menemukan bug atau masalah, kami mendorong Anda untuk membuka masalah pada pelacak masalah proyek kami untuk memberi tahu kami.
Bangun API Proyek Baru: Kami mendorong Anda untuk menjelajahi kreativitas Anda dan berkontribusi dengan membangun API proyek lengkap. API ini harus memberikan solusi komprehensif yang dapat membantu pengembang dalam membangun proyek yang kompleks untuk menunjukkan keterampilan dan kemampuan mereka. Kontribusi Anda di bidang ini akan sangat bermanfaat bagi masyarakat.
Draf proposal dan diskusikan tentang perselisihan: Sebelum menyelam ke dalam proyek Anda, kami sarankan menyusun proposal. Ini dapat mencakup peta pikiran atau garis besar API yang ingin Anda bangun dan potensi manfaatnya. Bergabunglah dengan komunitas Discord kami, di mana Anda dapat berbagi proposal, mendiskusikan ide, dan mengumpulkan umpan balik dari sesama kontributor. Terlibat dalam diskusi ini akan meningkatkan portofolio backend Anda dan membantu membentuk arah masa depan proyek.
Kami menghargai antusiasme Anda dan menantikan kontribusi Anda yang berharga untuk proyek API Hub Open Source kami.
Bersama -sama, kita dapat menumbuhkan lingkungan kolaboratif dan membuat dampak yang signifikan dalam lanskap integrasi API.
Klik di sini untuk panduan kontribusi terperinci.
Terima kasih atas minat Anda untuk berkontribusi pada proyek FreeAPi dengan membuat aplikasi frontend yang mengonsumsi freeapis! Upaya Anda memainkan peran penting dalam meningkatkan pengalaman pengguna dan memperluas jangkauan API kami. Ikuti panduan ini untuk memastikan proses kontribusi yang lancar dan kolaboratif.
Klik di sini untuk panduan kontribusi terperinci untuk pengembang frontend!
Terima kasih atas minat Anda untuk berkontribusi pada proyek FreeAPi untuk meningkatkan cakupan kode layanan API kami yang membantu kami mengirimkan titik akhir yang kuat yang diuji medan perang. Ikuti panduan ini untuk memastikan proses kontribusi yang lancar dan kolaboratif.
Klik di sini untuk panduan kontribusi terperinci untuk meningkatkan cakupan kode.
Dokumen Swagger: https://api.freeasi.app
CATATAN: Dokumen Swagger dihasilkan secara otomatis dari file swagger.yaml . Saat menjalankan proyek secara lokal, pastikan Anda mengubah URL ke http://localhost:<port_from_.env>/api/v1 di bidang servers/url Docs Swagger.
