對於設計與營運 API 來說,版本控管與切換可謂諸多重大考量之一。因此,最好於一開始即採取一些機制,以避免日後衝擊。
為了避免意外或不相容的變更,最好要求每個需求都註明版本。應避免使用預設版本,因為後續將非常難變更。
建議於標頭裡註明版本及其他中繼資料。將其與自定內容形態 (content type) 一起擺在 Accept 標頭中,例如:
Accept
Accept: application/vnd.heroku+json; version=3