API設計原則總結
最近本人重構公司一個web API元件,總結如下幾條原則:
- 引數比較簡單的情況下,儘量放在URL裡面,方便使用; 引數比價複雜,或者需要加密,則放在 body 裡面;
- 儘量按照REST風格來,按照資源進行組織;
- 老的介面,如果不符合風格,如果沒有人使用,或者只是內部人用,則刪除,換新的; 通知相關人員換到新介面;
- 如果使用比較廣泛,則保留;
- 如果有使用場景,也保留。
相關推薦
API設計原則總結
最近本人重構公司一個web API元件,總結如下幾條原則: 引數比較簡單的情況下,儘量放在URL裡面,方便使用; 引數比價複雜,或者需要加密,則放在 body 裡面; 儘量按照REST風格來,按照資
JavaScript 的 API 設計原則
rst 執行 creat 錯誤 htm ora 大小 閱讀 fontsize 前言 本篇博文來自一次公司內部的前端分享,從多個方面討論了在設計接口時的原則,總共包含了七個大塊。系鹵煮自己總結的一些經驗教訓。同時也參考了一些文章,地址會在後面貼出來。很難做到詳盡充實,如果
深入淺析JavaScript的API設計原則(轉載)
query 定義 檢測 缺省值 fine spl contex index cin 一、接口的流暢性 好的接口是流暢易懂的,他主要體現如下幾個方面: 1.簡單 操作某個元素的css屬性,下面是原生的方法: ? 1 document.querySelect
6大設計原則總結
單一職責原則 單一職責原則的目標是類,通過設計介面,使得類從功能上更加純粹,只有一種職責。 這樣設計介面後,整體會更加清晰明瞭,條理分明。不會有混亂的感覺。 里氏替換原則 總結起來很簡單,父
設計模式常用設計原則總結
一、單一職責原則(SRP) 就一個類而言,應該僅有一個引起它變化的原因。 舉個栗子 俄羅斯方塊,下落,旋轉,碰撞判斷,移動,堆積遊戲邏輯可以在不同平臺複用,介面和遊戲邏輯要分離。 總結 如果一個類承擔的職責過多,就等於把這些職責耦合在一起,一個職責的變化可能消弱
javascript的api設計原則
前言 本篇博文來自一次公司內部的前端分享,從多個方面討論了在設計介面時遵循的原則,總共包含了七個大塊。系滷煮自己總結的一些經驗和教訓。本篇博文同時也參考了其他一些文章,相關地址會在後面貼出來。很難做到詳盡充實,如果有好的建議或者不對的地方,還望不吝賜教斧正。 一、介面的流暢性 好的介面是流暢易懂的,他主
Hbase 表的設計原則 ————總結
1、列族的數量及列族的勢 建議將HBase列族的數量設定的越少越好。當強,對於兩個或兩個以上的列族HBase並不能處理的很好。這是由於HBase的Flushing和壓縮是基於Region的。當一個
Java面向物件16種設計原則(總結版)
Java面向物件16種設計原則 一 類的設計原則 1 依賴倒置原則-Dependency Inversion Principle (DIP) 2 里氏替換原則-Liskov Substitution Principle (LSP) 3 介面分隔原則-Int
軟體工程六大設計原則總結,案例演示
目錄 一、單一職責原則 二、介面隔離原則 三、依賴倒轉原則 四、里氏替換原則 五、開閉原則 六、迪米特原則 七、設計原則總結 八、原始碼地址
軟件架構設計學習總結(23):軟件架構設計的6大原則
str 軟件架構 edge 程序員 難點 posit not 幫我 mman 1. 單一職責原則(Single Responsibility Principle - SRP) 原文:There should never be more than one reason fo
Restful API 設計參考原則
width 包裝 修改 api開發 司機 word 屬性 add 數據返回 在項目中,需要為後臺服務撰寫API。剛開始接觸的時候,並沒有考慮太多,就想提供URL,服務端通過該URL進行查詢、創建、更新等操作即可。但再對相關規範進行了解後,才發現,API的設計並沒有那麽簡單,
( 轉 ) 優秀REST風格 API的設計原則
獲取 主頁 找到 子域 employ html 個人理解 let elf 設計優秀的REST風格API非常困難!API是服務提供方和使用方之間的契約,打破該契約將會給服務端開發人員招來非常大的麻煩,這些麻煩來自於使用API的開發人員,因為對API的改動會導致他們的移動app
PHP彩票源碼論壇 API設計的十大原則
標準 api 你是 傳統 移植 with 什麽 選項 相同 1.只做你今天需要的這是最頂級的規則,只解決今天必須解決的問題,PHP彩票源碼論壇bbs.yasewl.com最小化需要完成的答案。解決明天的問題的誘惑力是巨大的,但是一定要頂住誘惑!不要提前發布代碼,重點是註重縮
Web API介面設計經驗總結
在Web API介面的開發過程中,我們可能會碰到各種各樣的問題,我在前面兩篇隨筆《Web API應用架構在Winform混合框架中的應用(1)》、《Web API應用架構在Winform混合框架中的應用(2)--自定義異常結果的處理》也進行了總的介紹,在經過我的大量模組實踐併成功執行後,總結了這篇隨
設計模式七大原則總結
1.單一職責原則(Single Responsibility Principle) 目的:降低程式碼複雜度、系統解耦合、提高可讀性 含義:對於一個類,只有一個引起該類變化的原因;該類的職責是唯一的,且這個職責是唯一引起其他類變化的原因。 解決:將不同的職責封裝到不同的類
面向物件五大設計原則以及常見設計模式總結
儘管本人已經從事OOP程式設計好幾年,但對於OOP程式設計的很多精髓依舊瞭解不深。加之最近專案不緊,特抽出時間總結一些面向物件設計原則以及設計模式的相關內容,加深自己的理解同時也希望可以幫到其他人。 note:程式設計是一門技術更是一門藝術,藝術來源於生活又高於生活。下面介紹的很多東西很多都
Effective Objective-C 2.0 總結與筆記(第三章)—— 介面與API設計
第三章:介面與API設計 在開發應用程式的時候,總是不可避免的會用到他人的程式碼,或者自己的程式碼被他人所利用,所以要把程式碼寫的更清晰一點,方便其他開發者能夠迅速而方便地將其整合到他們的專案裡。 第15條:用字首避免名稱空間衝突 Objective-C
優秀REST風格 API的設計原則
本文由逍遙子翻譯自:https://codeplanet.io/principles-good-restful-api-design/文中註釋由逍遙子根據個人理解填寫,轉載時請附帶本文的連線。設計優秀的REST風格API非常困難!API是服務提供方和使用方之間的契約,打破該契
梳理REST API的設計原則
什麼是 REST ? REST架構風格描述了六個約束。應用於體系結構的這些約束最初由Roy Fielding在他的博士論文中提出(參見 https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm)該文是RESTful-sty
設計模式個人總結,介面隔離原則總結
總結經驗 近期自學Unity引擎,學到了關於設計模式這一塊,以前學習Java多次接觸設計模式,也在應用的開發過程中頻繁使用。雖然開發過程中沒有特意去強調使用設計模式,但設計模式的使用總是潛移默化的,