Werner Vogels – 6 Pelajaran untuk Desain API yang Baik

 (aws.amazon.com)
30 poin oleh xguru 2022-01-26 | 4 komentar | Bagikan ke WhatsApp
  • Catatan tentang "6 prinsip untuk membuat API yang baik yang dipelajari AWS selama 15 tahun"

  1. API itu abadi!

  2. Tolong jaga kompatibilitas mundur.

  3. Bangunlah dengan memulai dari use case pelanggan.

  4. Buat API yang error-nya eksplisit.

  5. Buat API yang tujuan dan cara pakainya bisa langsung dipahami.

  6. Pastikan detail implementasi tidak bocor.

  • Hal-hal yang sering keliru dalam desain API awal

  • Membuat API yang sangat mudah dikembangkan dengan Smithy

Bacaan terkait

4 komentar

 
xguru 2022-01-30
 
edunga1 2022-01-26

Saya paling merasa relate dengan poin ke-5.

Saya pernah menonton "Apakah REST API seperti itu sudah cukup baik?" yang dirujuk di situ, dan itu bagus: https://tv.naver.com/v/2292653

Saya biasanya tidak terlalu memperhatikan informasi semantik seperti ini, tetapi kalau melihat GitHub API, informasi seperti ini juga diberikan dengan baik, jadi terasa kalau API-nya dibuat dengan bagus.
 
ehlegeth 2022-01-26

Sepertinya ini konten yang bagus.

Khususnya poin 1 dan 4 tampaknya selalu menjadi hal yang saya bicarakan saat melakukan review.

Poin 3 tampaknya sejalan dengan yang pernah dikatakan Joshua Bloch, "Write to Your API Early and Often". (https://www.youtube.com/watch?v=aAb7hSCtvGw)
 
nicewook 2022-01-26

Kalau dirangkum seperti ini memang terlihat seperti hal yang sudah jelas, tetapi saat benar-benar melakukannya, rasanya kita tetap berulang kali melakukan kesalahan yang sama.