Kursus Singkat 101
10 Modul
5 Minggu

Informasi Umum

Klik untuk menyalin

Pengantar titik akhir


Modul terakhir diakhiri dengan pembuatan proses bisnis pertama. Kami menemukan cara membuat logika proses, menerima parameter input tertentu, melakukan perhitungan, dan mengeluarkan jawaban. Masih menjawab pertanyaan utama. Bagaimana cara mengaktifkan proses bisnis yang dibuat dan menjalankannya?

Untuk mengatasi masalah ini, titik akhir dimaksudkan - titik kunci interaksi dengan aplikasi. Pada modul pertama, kita telah berinteraksi dengan API eksternal. Ini dimungkinkan berkat kehadiran titik akhir. Mereka dijelaskan dalam dokumentasi, dan kami membacanya dan memahami metode apa dan URL apa yang diperlukan untuk mengirim permintaan untuk mengakses sumber daya tertentu.

Untuk memahami, mari kita lihat implementasi titik akhir menggunakan contoh spesifik. Pada modul ketiga, model database dibuat. Pada saat yang sama, bersamaan dengan pembuatan tabel, titik akhir secara otomatis dibuat untuk berinteraksi dengannya. Mari kita pergi ke bagian titik akhir (di panel kiri) dan melihatnya.


Pada contoh tabel " city " dengan informasi tentang kota, dapat dilihat bahwa sudah memiliki 6 titik akhir untuk operasi data dasar.

  • GET /city - mendapatkan semua data dari tabel
  • GET /city/:id - mendapatkan data tentang kota dengan id yang ditentukan
  • POST /city - menambahkan rekor baru ke tabel
  • PUT /city/:id - penggantian lengkap catatan dengan id yang ditentukan dalam tabel
  • PATCH /city/:id - penggantian sebagian catatan dengan id yang ditentukan dalam tabel
  • DELETE /city/:id - menghapus record dengan id yang ditentukan dari tabel

Pengaturan Umum

Anda dapat membuka pengaturan untuk setiap titik akhir dan mempelajarinya lebih detail. Misalnya, pertimbangkan titik akhir GET /city/:id


Gambar yang kita lihat sangat mirip dengan apa yang telah kita lihat saat membuat permintaan ke API eksternal. Dalam satu kasus, kami hanya mengakses titik akhir yang sudah jadi, dan sekarang kami membuat dan mengonfigurasi titik akhir ini sendiri. Untuk mengonfigurasi, Anda harus menentukan:

  1. Metode permintaan . Dalam contoh ini, ini adalah metode GET .
  2. URL permintaan . Bagian pertama dengan jalur ke server tidak ditentukan. Ini sama untuk semua titik akhir aplikasi. Cukup dengan menentukan hanya akhir ( /city ). Parameter URL juga ditentukan di sini. Titik akhir dirancang untuk menerima informasi tentang kota tertentu, sehingga id-nya yang ditulis setelah “:” dilewatkan sebagai parameter.
  3. Endpoint Groups . Parameter ini tidak memengaruhi pengoperasian titik akhir dengan cara apa pun dan dimaksudkan hanya untuk kenyamanan organisasi. Semua titik akhir dapat dibagi menjadi grup tematik (folder). Dalam contoh ini, grup " city " berisi semua titik akhir untuk bekerja dengan data kota.
  4. Business Process . Ini adalah item konfigurasi yang paling penting dan merupakan sesuatu yang tidak dapat dilihat dengan cara apa pun saat mengirim permintaan ke titik akhir. Indikasi proses bisnis menentukan apa yang akan dilakukan titik akhir ini. Pada saat yang sama, titik akhir itu sendiri dapat tetap tidak berubah, ia akan menerima semua permintaan yang sama di alamat lama, dan pada saat yang sama, jika proses bisnis diganti, ia akan melakukan fungsi yang sama sekali berbeda. Proses bisnis untuk aktivitas basis data dasar dibuat secara otomatis. Mereka disebut proses bisnis sistem. BP tersebut tidak dapat diubah tetapi dapat diganti kapan saja dengan BP yang dibuat secara independen, dengan proses bisnis khusus.
  5. Input/Output variables . Proses bisnis yang dibuat menggunakan berbagai variabel input dan output, tetapi titik akhir tidak harus menggunakan semuanya. Bagian dapat dinonaktifkan atau dikonfigurasi sehingga titik akhir yang berbeda mengakses BP yang sama, dengan satu set variabel individu. Jenis permintaan dan tanggapan ( Request / Response type ) juga dikonfigurasi di sana. Paling sering, jenis ini adalah JSON, tetapi, jika perlu, opsi lain dapat digunakan, seperti XML atau Render File (jenis respons ini digunakan di titik akhir untuk bekerja dengan file).

Pengaturan middleware

Pengaturan umum sudah cukup untuk membuat dan selanjutnya menggunakan titik akhir, tetapi parameter tambahan dapat digunakan jika perlu. Yang paling penting adalah aktivasi Middleware dengan token Auth .


Penggunaannya memungkinkan Anda untuk menolak akses ke titik akhir ini kepada pengguna yang belum diotorisasi atau tidak termasuk dalam kelompok tertentu (misalnya, akses hanya dapat diberikan kepada administrator dan ditolak oleh pengguna lain).

Pengaturan pencatatan dan keluaran

Selain itu, Anda dapat menggunakan pengaturan pada tab Settings untuk menambahkan tajuk atau isi permintaan, serta untuk menyembunyikan bidang yang nilainya tidak disetel dari respons.


Was this article helpful?
Masih mencari jawaban?