Cara Merancang REST API yang Lebih Baik

 (r.bluethl.net)
26 poin oleh xguru 2022-03-11 | 2 komentar | Bagikan ke WhatsApp
  • Jaga konsistensi: URL/header/autentikasi/kode status..
  • Gunakan format tanggal ISO8601 UTC
  • Hanya Public Endpoint yang dikecualikan dari autentikasi. Selebihnya semuanya wajib diautentikasi
  • Sediakan endpoint health check
  • Versioning API
  • Terapkan autentikasi API key
  • Gunakan kode status dan method HTTP yang masuk akal
  • Gunakan nama yang sederhana dan dapat menjelaskan dirinya sendiri untuk setiap endpoint
  • Gunakan respons error standar
  • Kembalikan resource yang dibuat dari POST
  • Gunakan PATCH alih-alih PUT
  • Sebisa mungkin spesifik
  • Gunakan pagination
  • Buat setiap resource dapat diperluas (rancang agar juga bisa mengembalikan informasi tambahan dengan memberi query param seperti expand)

Bacaan terkait

2 komentar

 
eajrezz 2022-03-14

Belakangan ini saya sering menemukan pembahasan terkait di berbagai tempat, dan saya merekomendasikan "Desain API Web yang Dijelaskan oleh Benda-Benda Sehari-hari". Karena judul dan sampulnya, buku ini bisa disalahpahami sebagai semacam buku analogi ringan tentang internet, tetapi ini adalah buku yang sangat bagus karena menonjolkan wawasan penulis—yang memang berprofesi di bidang desain API—tentang desain API.