API通用設計原則

2021-06-19 16:44:12 字數 714 閱讀 9991

什麼是好的

api?

·        

完備

be complete

)對確定重點支援的使用者場景具有完備的功能支援。就是說,使用者通過對一組

api的呼叫能夠完成預期的功能。

·        

不冗餘

be minimal

)在完備的前提下,

api只提供最小的功能集合。不缺少、不冗餘。

·        

簡單清晰

be ****** & clear

)介面設計簡單清晰。每個介面都有自己明確的語義,並只專注於盡量單一的功能。產品概念簡單、關係清楚。

·        

易於學習

be easy to learn & use

)符合使用者的直覺;介面設計有統一的正規化,使用者可以舉一反三。極致是沒有文件使用者也知道怎樣呼叫介面。

·        

可擴充套件

be extensible

)設計具有擴充套件性,能夠在一定程式上適應變化,

api在發展中具有

「後向相容性」(

backward-compatibility

)。

服務API設計 之 API設計原則

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

通用設計的原則

本文的作者,一群架構設計師,產品設計師,工程師和環境設計研究人員,一起共同建立了以下一些通用設計的原則以引領廣義設計學科,包括環境,產品和交流等。這七項原則可 用於評估已有的設計,引導設計過程以及使設計師和消費者都了解更可用的產品和環境的特徵。原則的陳列格式 原則的名稱 原則中包涵的關鍵核心概念的簡...

API 介面設計 原則

api 設計乙個非同步介面實踐 知乎 介面設計的16個原則 accident web api介面設計經驗總結 hugejihu9的專欄 csdn部落格 聊聊restful 介面設計篇 一 就浩這口 csdn部落格 api 介面設計問題 獲取所有資料 和 獲取我的資料 介面是分開的嗎 v2ex wha...