RESTful API - Versioning

Penjelasan

Jangan merusak RESTful API

  • Usahakan tidak pernah merusak kompatibilitas tiap kita melakukan upgrade
  • misal : ketika response nya A, dirubah menjadi B
  • Versioning hanya diperlukan ketika kita memang perlu merusak kompatibilitas RESTful API
  • cost akan sangat mahal di sisi client
  • Namun jika memang diperlukan, maka wajib melakukan versioning

Versioning

  • memberi tahu bahwa kita memiliki banyak versi terhadap aplikasi RESTful API

Versioning pada URL

  • http://api.example.com/v1/products
  • http://api.example.com/v2/products
  • http://api.example.com/2019/products
  • http://api.example.com/2020/products

Versioning Menggunakan HTTP Header

  • HTTP Header => API-Version:1
  • HTTP Header => API-Version:2
  • HTTP Header => X-API-Version:2019
  • HTTP Header => X-API-Version:2020

RESTful API yang baik tidak akan pernah merusak API. Sehingga sebenarnya tidak butuh membuat API versi baru.

 

Poin / Ide

Scroll to Top