Titik akhir adalah bagian penting dari proses bisnis dan pengembangan aplikasi secara umum. Dalam artikel ini, kami mendefinisikan apa itu endpoint, mengapa kami membutuhkannya, dan cara membuatnya di platform AppMaster.io.
Apa itu titik akhir?
Titik akhir adalah gateway yang menghubungkan proses server aplikasi dengan antarmuka eksternal. Dengan kata lain, ini adalah alamat tujuan pengiriman permintaan.
Penting untuk menyebutkan cara kerja API untuk memahami apa itu titik akhir. API adalah singkatan dari antarmuka pemrograman aplikasi. Aplikasi menggunakan API untuk berinteraksi dengan layanan pihak ketiga dan penggunanya.
Untuk terhubung ke API, Anda perlu mengirim permintaan. Untuk pemrosesan permintaan yang benar, klien harus menyediakan penunjuk sumber daya universal (URL), metode HTTP, dan, bergantung pada metode, menambahkan header, isi, dan parameter permintaan. Header menyediakan metadata tentang permintaan, sedangkan isi berisi data, seperti bidang untuk baris baru dalam database.
API akan memproses permintaan dan mengirim respons yang diterima dari server. Respons akan berisi kode status, yang merupakan bagian dari pesan respons HTTP yang menginformasikan klien tentang hasil permintaan. Misalnya, kode 200 digunakan jika operasi berhasil diselesaikan, 500 jika terjadi kesalahan server internal.
Titik akhir bekerja sama dengan metode API. Ini adalah URL khusus yang digunakan aplikasi untuk berkomunikasi dengan layanan pihak ketiga dan penggunanya. URL adalah rute yang dapat menangani berbagai metode permintaan. Setiap jenis permintaan adalah titik akhir yang terpisah. Ada lima jenis utama:
- GET — mendapatkan informasi dari server; itu tidak memerlukan badan permintaan;
- POST — membuat objek baru dalam database, memerlukan badan permintaan dengan bidang objek ini;
- PUT — sepenuhnya me-reset objek tertentu dalam database;
- PATCH — mirip dengan PUT, me-reset objek tertentu dalam database, tetapi hanya akan memperbarui bidang yang disebutkan di badan permintaan;
- DELETE — menghapus objek dari database.
Saat membuat permintaan khusus, berbagai parameter dapat ditambahkan ke dalamnya. Kombinasi parameter ini dan URL mewakili URI — Uniform Resource Identifier. Ini menunjukkan di mana dan bagaimana menemukan sumber daya.
Bagaimana Anda dapat mengonfigurasi titik akhir pada platform AppMaster.io?
Di bagian Endpoint pada platform AppMaster.io, Anda dapat melihat semua endpoint yang dibuat secara otomatis dan endpoint proyek Anda. Jika layar dan pembuatan halaman secara otomatis dalam proyek Anda diaktifkan, titik akhir yang sesuai akan dibuat secara otomatis untuk setiap model data yang dibuat. Juga, titik akhir dapat dibuat secara otomatis ketika menginstal beberapa modul, misalnya, Otorisasi (Auth), Negara dan kota, dan lainnya.
AppMaster.io memungkinkan Anda bekerja dengan beberapa jenis API titik akhir:
- API untuk mengakses backend dari klien dan sistem pihak ketiga;
- webhook untuk menerima pemberitahuan dari sistem pihak ketiga;
- WebSockets, untuk membuka sesi komunikasi interaktif dua arah antara browser dan server tanpa meminta tanggapan dari server.
Semua titik akhir dikelompokkan. Dalam setiap grup, Anda akan menemukan semua titik akhir yang sesuai, jenis permintaannya, URL, dan proses bisnis yang terhubung dengannya. Semua titik akhir dapat dihapus dan diedit oleh Anda.
Saat membuat atau mengedit titik akhir, opsi berikut tersedia di jendela konfigurasi:
- Metode permintaan. DAPATKAN, POSTING, PUT, DELETE, atau PATCH.
- URL permintaan. Bagian pertama dengan jalur ke server tidak ditentukan karena sama untuk semua titik akhir aplikasi. Cukup dengan mengatur akhir, misalnya, /users. Parameter URL juga ditentukan di sini. Misalkan titik akhir dirancang untuk menerima informasi tentang pengguna tertentu. Dalam hal ini, ID-nya harus ditulis setelah ":" (/users/:id) dan diteruskan sebagai parameter.
- Grup titik akhir. Parameter ini bertujuan untuk mengatur dan menyusun pekerjaan dengan titik akhir. Semua titik akhir dapat dibagi menjadi beberapa grup (folder).
- Proses bisnis. Salah satu parameter paling kritis yang menentukan apa yang akan dilakukan titik akhir. Pada saat yang sama, titik akhir itu sendiri dapat tetap tidak berubah. Itu akan menerima semua permintaan yang sama di alamat lama, dan jika proses bisnis diganti, itu akan melakukan fungsi yang berbeda. Proses bisnis untuk operasi basis data dasar dibuat secara otomatis. Anda tidak dapat mengeditnya, tetapi jika perlu, Anda dapat menggantinya dengan BP khusus.
Anda juga dapat mengatur middleware. Middleware adalah software perantara yang berfungsi sebagai filter saat memproses permintaan aplikasi. Middleware digunakan untuk memeriksa kondisi apa pun sebelum menjalankan permintaan. Misalnya, jika Anda membuat middleware untuk memeriksa otentikasi pengguna, middleware akan mengarahkan pengguna ke halaman login jika pengguna tidak login. Jika dia login, middleware tidak akan mengganggu pemrosesan permintaan, meneruskannya ke klien.
Membuat titik akhir di AppMaster.io
Mari kita pertimbangkan konfigurasi titik akhir dalam praktik dan menganalisisnya melalui contoh proyek Aviato. Anda dapat menemukan proses lengkap pembuatan proyek ini di kursus AppMaster.io.
Di dalam proyek, kami membuat dua proses bisnis:
- Validasi dan buat penerbangan — proses yang akan digunakan untuk menggantikan proses bisnis Buat penerbangan;
- Daftarkan penumpang — untuk mendaftarkan penumpang untuk penerbangan tertentu.
Sekarang kita dapat menggunakan proses ini untuk mengatur titik akhir dalam proyek.
Mari kita mulai dengan Validasi dan membuat proses bisnis penerbangan. Grup Penerbangan sudah memiliki titik akhir POST/penerbangan untuk membuat penerbangan. Sekarang kita perlu mengganti proses bisnis yang terpasang dengan yang baru. Untuk melakukan ini, kita perlu Mengedit titik akhir.
Di jendela konfigurasi, pilih proses bisnis yang diinginkan. Dalam kasus kami, ini adalah Validasi dan buat penerbangan BP. Setelah itu, kita perlu memilih semua variabel input yang diperlukan dan menyimpan perubahannya.
Sekarang kita dapat mengatur titik akhir berikutnya untuk proses bisnis Daftarkan penumpang.
Tujuan kami adalah membuat bagian untuk melihat penerbangan dan penumpang tertentu yang terkait dengannya dan menyiapkan proses untuk mendaftarkan penumpang baru.
Di grup Flights endpoint, kita perlu membuat endpoint baru: /flights/:id/register, di mana id mengacu pada penerbangan tertentu yang dapat kita gunakan sebagai input dalam proses bisnis.
Dengan mengklik ikon Plus, kita dapat menambahkan titik akhir baru. Metode permintaan akan menjadi POST karena kita membuat objek baru. Kami memilih proses Daftarkan penumpang untuk BP kami dan simpan semua perubahan yang dibuat.
Begitulah cara mudah membuat titik akhir di platform AppMaster.io. Video tutorial lengkapnya:
Kesimpulan
Titik akhir memainkan peran penting dalam pengoperasian API, yang, pada gilirannya, diperlukan untuk memperluas proyek dan integrasi layanan dan aplikasi yang nyaman. Platform tanpa kode AppMaster.io memudahkan pekerjaan dengan membuat dan mengonfigurasi titik akhir. Anda selalu dapat mendaftar di platform dan memeriksa semua fungsinya.
