Susunan API yang baik seharusnya ...

Susunan API yang baik seharusnya ...
Sebagai backend developer, salah satu tugas paling krusial ialah pembuatan fungsi-fungsi yang berhubungan dengan sistem basis data (database). Dalam kasus ini khususnya pada tahap penyusunan API (application programming interface). Terlepas dari bahasa pemrograman yang digunakan, semuanya menjadi sangat penting saat desain tampilan interface telah selesai dibangun. Sehingga menuntut terpenuhinya kebutuhan bagi para frontend developer maupun mobile developer akan fungsi-fungsi yang akan diterapkan pada layout yang akan disusun. Pembuatan sistem basis data seharusnya telah selesai dibentuk sebelumnya oleh system analyst. Meski kenyataannya tidak menutup kemungkinan para backend developer yang mengerjakan juga desain basis datanya. Selanjutnya fungsi-fungsi yang kemudian dituangkan dalam bentuk API mulai dikerjakan. Ritual ini dikhususkan bagi situs atau aplikasi yang menggunakan teknologi javascript dan mobile apps. Dewasa ini sangatlah banyak permintaan dari para client dan calon client dalam penggunaan teknologi yang dimaksud sebelumnya. Ada beberapa hal yang seharusnya patut diperhatikan dalam pembangunan API. Pertama, bentuk return/kembalian dari fungsi yang dibentuk berupa JSON. Rasanya poin ini menjadi yang paling pokok dalam penyusunan API, karena hal ini menentukan fungsi-fungsi yang dikerjakan oleh API berhasil dieksekusi. Termasuk pengembalian response yang berupa pesan jika perintah tersebut gagal atau terjadi kesalahan. Seharusnya JSON tersebut juga disusun memiliki key atau atribut yang dapat dikonsumsi oleh para frontend enginer guna mengelola tampilan yang sedang dibuatnya. Contohnya saat perintah yang dijalankan berhasil dieksekusi, maka return yang baik dan benar memiliki atribut (key) berupa “status”, ”code”, “message”, dan “data” (optional, jika berhubungan dengan basis data). Kedua, cara handle error dan conditional state/kondisi tertentu yang dilemparkan ke bentuk JSON juga layaknya perintah yang berstatus OK (berhasil). Tahap ini juga penting dikelola guna kemudahan dan banyaknya variasi pengembalian sistem kelola untuk para user atau pemakainya kelak. Jika tidak dilakukan error handling, hasilnya return yang akan diterima oleh pemakai akan monoton dan terkesan kaku untuk dikonsumsi. Belum lagi jika desain tampilan yang diterapkan tidak terlalu bagus, maka akan muncul kesan yang buruk terhadap website ataupun aplikasi dari para penggunanya. Yang terakhir adalah mengenai URL atau link API yang diajukan. Umumnya link-link API tersebut disusun berdasarkan tiga komponen yaitu, bentuk fungsi, kategori perintah, dan versi (optional, penulis juga jarang memakainya). Semua kombinasi ini dipadukan dengan susunan seperti contoh berikut, fungsi berupa “/api”, kategori perintah berbentuk tipe fungsi apa yang akan dijalankan yaitu “/user”, dan versi yang berupa “/v1” sebagai awalan pertama sebuah API selesai dibangun. Jadi lengkapnya yaitu, http://localhost:8000/api/v1/user/. Bentuk seperti tidak selalu benar, karena penulis juga masih dalam tahap belajar menuju kelayakan sebuah struktur code yang baik. Tak ketinggalan aplikasi pembantu bagi para backend enginer untuk pengelolaan API yang dibuatnya yaitu, postman. Dapat juga menggunakan “cURL” yang berupa perintah-perintah pada terminal console baik di sistem operasi windows maupun yang berbasis UNIX (linux dan macOS). Jika di depan ditemukan statement-statement maupun pernyataan yang tidak tepat hendaknya dapat ikut membantu untuk memperbaiki. Karena dengan adanya koreksi dari banyak kalangan user, diharapkan terdapat feedback yang positif bagi kedua belah pihak khususnya.
Author
Mohammad Anang23 posts

Remember to eat, sleep, and blink!



Related articles
0 Comments
  1. Tidak Ada Komentar.
Leave a Comment