Matawebsite Promo Lebaran 2022

Mendesain API yang Mudah Dikelola

date 15 Jan 2021
date Lev Yasin
date 398
date Web Programming
Mendesain API yang Mudah Dikelola

Merancang API itu mudah , Itu karena dalam hal desain API, ada banyak pertimbangan yang harus dipertimbangkan di luar fungsionalitas inti. Dari konvensi penamaan hingga manajemen versi, detail desain API dapat berarti perbedaan antara keberhasilan dan kegagalan.

Anda bisa menulis buku tentang desain API (sebenarnya, banyak orang pernah). Tetapi bagi para pengembang di luar sana yang tidak ingin membaca keseluruhan buku untuk mempelajari cara merancang API yang efektif, posting blog ini memberikan panduan singkat tentang desain API. Secara khusus, saya fokus pada dua faktor terbesar yang harus Anda pertimbangkan saat mendesain API: kegunaan dan konsistensi.

Kegunaan dan desain API

Saat mendesain API, mudah untuk melupakan pengguna akhir. Bagaimanapun, pengguna akhir API Anda adalah pengembang lain, dan Anda mungkin tidak menganggap pengembang sebagai pengguna akhir. Tetapi kenyataannya adalah mereka, dan mereka membutuhkan API yang sangat berguna untuk kebutuhan mereka.

Sebagai pengguna teknis sendiri, mengingat pengguna akhir saat merancang dan mengembangkan API sangatlah penting. Jika frontend yang cantik dapat menyembunyikan kutil dari aplikasi lama, API yang dirancang dan dibuat dengan buruk akan segera terlihat oleh para ahli yang akan menggunakannya. Meskipun kegunaan dapat menjadi konsep yang relatif subjektif, ada beberapa faktor utama yang harus dipertimbangkan untuk memastikan bahwa API Anda tidak hanya dapat digunakan tetapi juga mudah digunakan:

Autentikasi

Ada beberapa metode otentikasi berbeda, yang masing-masing memiliki kelebihan dan kekurangannya sendiri. Autentikasi berbasis kueri (meletakkan kunci API di parameter kueri sebuah permintaan) adalah yang paling mudah diterapkan tetapi dapat membuat API multi-pengguna lebih sulit untuk diterapkan. Di sisi lain, otorisasi token Bearer (meletakkan kunci API di header Otorisasi permintaan) sedikit lebih rumit dari sudut pandang pengujian (terutama bila dikombinasikan dengan otentikasi OAuth), tetapi ini adalah solusi yang sangat baik untuk integrasi pihak ketiga . Apa pun pilihan yang Anda buat, mengidentifikasi bagaimana pengguna akhir Anda akan bekerja dengan API Anda harus memandu metode yang Anda dukung.

Pembuatan Versi

Banyak organisasi membutuhkan API yang mereka gunakan untuk mengimplementasikan versi API untuk memastikan stabilitas. Tidak masalah bagaimana Anda membuat versi API Anda (saya telah melihat ratusan argumen mengenai cara yang "benar" untuk melakukannya), tetapi penting bagi Anda untuk melakukannya (kecuali jika Anda adalah satu-satunya konsumen API, dalam hal ini Anda kemungkinan besar bisa pergi tanpa membuat versi). Ini meyakinkan pengguna Anda bahwa Anda tidak akan mengubah parameter input atau format output secara sembarangan tanpa memberi mereka cukup waktu untuk memigrasi implementasi mereka.

API Client

Pada intinya, API yang paling dapat dikembangkan dan dipelihara diperlakukan dengan perhatian yang sama seperti antarmuka pengguna lainnya. Mempertimbangkan praktik terbaik dan pola ideal dapat membantu tidak hanya meningkatkan daya jual suatu API, tetapi juga proses keputusan yang dibuat untuk itu di masa mendatang. Meskipun mudah untuk mempromosikan kegunaan, cara terbaik untuk memastikan kegunaan API adalah dengan membuat SDK dan klien resmi secara internal. Hal ini memastikan bahwa Anda tidak hanya menguji API - Anda juga mendapatkan pengalaman praktis tentang cara kerjanya dari perspektif pengguna akhir.

Konsistensi

Berkaitan dengan kegunaan dalam desain API adalah konsistensi. Meskipun tidak selalu mungkin (atau praktis) untuk mengikuti "praktik terbaik" dalam konteks API Anda, memiliki pendapat dan mematuhinya dapat sangat membantu dalam memastikan kualitas API - dan mungkin yang terpenting, kemudahan pemeliharaannya. Konsistensi dapat datang dalam berbagai bentuk, tetapi pada intinya, itu berarti bahwa titik akhir A dan titik akhir B tidak hanya terlihat serupa, tetapi juga berfungsi serupa. Saat mendesain API Anda, ada beberapa hal yang harus Anda pertimbangkan sebelumnya untuk mendorong konsistensi desain dengan lebih baik:

Singular vs Plural Nouns

Topik yang diperdebatkan dengan hangat di antara pengembang API, kenyataannya adalah tidak masalah apakah Anda menggunakan Singular vs Plural Nouns, hanya apa pun yang Anda pilih yang harus Anda patuhi. Meskipun ini mungkin tampak terlalu berlebihan, memutuskan apakah titik akhir API Anda akan terlihat seperti / api / penulis / 1 atau / api / author / 1 sebelumnya akan mengurangi kebingungan pengguna dan merampingkan penambahan titik akhir API baru di masa mendatang.

Metode Permintaan HTTP

DAPATKAN, PUT, POSTING, PATCH, HAPUS … Meskipun saya memiliki pendapat pribadi tentang kapan masing-masing metode permintaan ini harus digunakan (sesuatu yang berbicara lebih kepada kegunaan daripada konsistensi), yang paling penting saat merancang dukungan metode permintaan HTTP API Anda sendiri adalah bahwa Anda menggunakan pilihan Anda secara konsisten. Jika POST digunakan untuk membuat entri baru dan memperbaruinya dalam satu sumber daya, maka Anda tidak boleh menggunakan PATCH untuk kasus penggunaan yang sama di sumber lain.

Matawebsite Promo
lev_yasin.png

Lev Yasin

Instruktur Web Programming Mataweb

Sangat tertarik dengan dunia Pemrograman Web & Mobile, saat ini fokus pada bagian Backend Web Developer, menggunakan PHP sebagai bahasa pemrograman utama, biasanya saya menggunakan Laravel.

Artikel Populer

Halo, ada yang bisa kami bantu?
Daftar Sekarang