接口設計之版本管理

API版本控制策略

1. URL策略

API URL 中指定版本號

• https://nealma.com/api/v1.0/login
• https://nealma.com/api/v1.1/login

2. Header策略

HTTP Header 中指定版本號

1. :method: POST
2. :path: /api/login
3. :scheme: https
4. accept: application/json, text/plain, */*
5. accept-encoding: gzip, deflate, br
6. authorization: Bearer xxx
7. api-version: v1.1

API版本升級原則

1. 小版本升級

小版本的升級，可以直接在接口中兼容業務邏輯；保證原有數據結構，增加新的數據結構（只增加新字段，不刪除原字段）。

2. 大版本升級

通常大版本更新，原有直接不需要處理，直接新建Controller，實現新的API業務邏輯，客戶端自行處理。

閱讀更多 碼向未來 的文章

關鍵字: Scheme 數據結構 JSON