服務API設計 之 API版本規範

2021-10-09 17:55:12 字數 362 閱讀 3637

正式發布的api包必須是release版本

eg.

cn.gov.zcy.paas.template

template-api

2.1.1.release

使用 《semantic versioning》風格

version號由 「major.minor.patch」 三段組合構成,version號增加含義:

major version:【主版本號】代表api發生了不相容的變更,即使是微小的不相容。

minor version:【次版本號】代表以相容的方式新增了功能、特性

patch version:【補丁版本號】代表以相容的方式做了bugfix

服務API設計 之 API設計原則

對接xx業務時,xx業務具備的功能和api全靠跑業務負責人那反覆逐個詢問 確認。用哪個api 怎麼用 有沒有限制 等等 各個業務間,甚至同一業務內,api風格不統一。xx業務api效能方面未知。隨著業務的演進,開放的api持續在增加,但類同的很多 api編碼規範迫在眉睫 自解釋 易學習 易使用 難誤...

API介面規範

對於資源的具體操作型別,由http動詞表示。常用的http動詞有下面四個 括號裡是對應的sql命令 get select 從伺服器取出資源 一項或多項 post create 在伺服器新建乙個資源。put update 在伺服器更新資源 客戶端提供改變後的完整資源 delete delete 從伺服...

api介面規範

api與使用者的通訊協議,總是使用https協議,確保互動資料的傳輸安全。應該將api的版本號放入url。另一種做法是,將版本號放在http頭資訊中,但不如放入url方便和直觀。採用多版本並存,增量發布的方式 v n代表版本號,分為整形和浮點型 整形的版本號 大功能版本發布形式 具有當前版本狀態下的...