Artikel ini akan menunjukkan kepada Anda cara bekerja dengan API di platform tanpa kode tingkat pro kami, AppMaster.io. Namun, pertama-tama, mari ingatkan Anda tentang beberapa informasi dasar tentang API.
pengantar
API berarti Antarmuka Pemrograman Aplikasi. Ini adalah bagaimana klien dan server dapat berkomunikasi satu sama lain. Klien dan server mengirim permintaan dan tanggapan, dan API bertindak sebagai perantara di antara keduanya.
Interaksi klien-server ini harus sederhana, dapat dimengerti, dan nyaman. Ini menyederhanakan tugas pengembang (tidak perlu menemukan kembali layanan baru) dan pengguna (layanan lebih mudah dipelajari jika berfungsi dengan baik). Ada beberapa jenis API:
- API layanan web, XML-RPC, dan JSON-RPC, SOAP;
- API WebSocket;
- API berbasis perpustakaan, Java Script;
- API berbasis kelas, C# API, Java.
Pada platform AppMaster.io tanpa kode, kami menggunakan gaya REST API.
REST atau seluruh Representational State Transfer adalah gaya arsitektur interaksi (pertukaran informasi) antara klien dan server. Layanan di REST API berkomunikasi menggunakan protokol HTTP.
Gaya REST memiliki keunggulan tertentu. Keuntungan utama dari REST adalah fleksibilitas yang sangat baik. REST terdiri dari pedoman sederhana, yang memungkinkan pengembang untuk menerapkan persyaratan dalam format mereka. REST memiliki kinerja tinggi, yang sangat penting, misalnya, untuk memuat cepat di perangkat seluler. Itu sebabnya semua perusahaan besar seperti Twitter dan Google telah lama menerapkan REST API untuk produk mereka. Anda dapat membaca lebih lanjut tentang pekerjaan dan keunggulan utama REST API di artikel kami.
Struktur permintaan apa pun mencakup lima komponen utama: metode HTTP, titik akhir, header dan isi, parameter permintaan.
REST API menggunakan 4 metode HTTP dasar untuk bekerja dengan sumber daya (informasi), dan masing-masing menjelaskan apa yang harus dilakukan dengan sumber daya:
- POST — pembuatan sumber daya;
- GET — mendapatkan sumber daya;
- PUT — pembaruan sumber daya;
- DELETE — menghapus sumber daya.
Sumber daya adalah informasi apa pun (dokumen, gambar, video, teks, dan sebagainya). Pada platform tanpa kode AppMaster.io, informasi ini dikirimkan ke klien dalam beberapa format, termasuk yang paling umum — JSON.
Titik akhir berisi URI — Uniform Resource Identifier (pengidentifikasi sumber daya seragam), yang menunjukkan di mana dan bagaimana menemukan sumber daya di Internet dan menyertakan URL (URL atau Uniform Resource Location adalah alamat web lengkap).
Header menyampaikan informasi ke klien dan server. Header terutama menyediakan data otentikasi: kunci API, nama atau alamat IP komputer tempat server diinstal, dan format respons.
Tubuh diperlukan untuk meneruskan informasi tambahan ke server: data tubuh adalah data yang, misalnya, ingin Anda tambahkan atau ganti.
Dokumentasi API untuk aplikasi Anda di platform kami dibuat secara otomatis dan disimpan dalam format OpenAPI (Swagger) di backendnya.
Anda tidak perlu benar-benar memahami cara kerjanya untuk mempelajari cara membangun API di AppMaster.io. Anda akan memahami prinsip-prinsip dasar dengan mempelajari tentang alat platform. Selain itu, bagian tengah API dibuat oleh AppMaster.io. Sebagian besar pengaturan dibuat secara default atau saat menghubungkan modul. Misalnya, modul kami menyediakan alat untuk berintegrasi dengan API untuk surat.
Anda perlu membuat perubahan kecil pada beberapa pengaturan API secara manual saat mengintegrasikan (menghubungkan) aplikasi Anda ke aplikasi lain atau sumber daya eksternal. Selanjutnya, kita akan melihat bagaimana melakukan ini.
Pembuatan API menggunakan platform tanpa kode AppMaster.io
Jadi, Anda dapat menemukan pengaturan API di beberapa tempat di platform kami.
Cara membuat Titik Akhir API pada platform tanpa kode AppMaster.io
Masuk ke akun Anda untuk proyek yang ada.
Buka Desainer Model Data. Di Data Model Designer Anda akan melihat model dengan data yang ingin Anda proses menggunakan API titik akhir. Di setiap proyek, di awal, selalu ada satu model secara default, Pengguna. Jika Anda berada dalam proyek baru dan Anda belum memiliki model, buatlah.
Tetapkan tautan di antara model Anda dan simpan proyek.
Buka bagian Endpoints di menu kiri layar.
Di sini Anda akan melihat daftar semua titik akhir Anda dan metode REST API yang tersedia untuk mereka yang terhubung ke setiap model di bidang proyek. Anda akan menghapus metode yang tidak perlu dan mengubah pengaturannya (ikon Roda Gigi dan ikon Keranjang Sampah).
Jika tidak ada titik akhir yang sesuai dalam daftar, Anda dapat membuat yang baru dengan mengklik tombol Titik Akhir Baru dan memilih jenis yang sesuai. Jendela modal dengan pengaturan Endpoint akan terbuka.
Cara membuat API Eksternal pada platform tanpa kode AppMaster.io
Buka bagian Logika Bisnis di menu sebelah kiri.
Di sini Anda dapat membuat permintaan API eksternal di tab Permintaan API Eksternal (opsi ini dalam versi beta).
Selain itu, seperti yang kami sebutkan di atas, semua dokumentasi dibuat secara otomatis dan disimpan dalam format OpenAPI (Swagger) di bagian belakang aplikasi Anda.
Swagger adalah dokumentasi dan kemampuan untuk menguji semua titik akhir langsung di tempat tanpa menggunakan aplikasi pihak ketiga seperti Postman.
Kesimpulan
Seperti yang Anda lihat, membuat dan mengubah setelan API menggunakan tanpa kode sangatlah sederhana dan membutuhkan waktu yang minimal. Jika Anda belum memiliki akun di AppMaster.io, bergabunglah dengan kami dan daftar untuk versi uji coba .
