restful-api-design-references
之所以創(chuàng)建這個(gè) repository,是因?yàn)槲蚁M占恍┍容^好的有關(guān)于 RESTful API 設(shè)計(jì)的參考文獻(xiàn)。偶爾回顧,偶爾改進(jìn),大家一起來吧~
如果你有更好的私藏文章,不凡分享出來,獨(dú)樂樂不如眾樂樂,(⊙o⊙)
RESTful 介紹及設(shè)計(jì)思路
Principles of good RESTful API Design(譯:好 RESTful API 的設(shè)計(jì)原則 )簡(jiǎn)單易懂,條理清晰,推薦
Best Practices for Designing a Pragmatic RESTful API(譯:RESTful 最佳實(shí)踐 譯文2)有實(shí)際的案例 Enchant
HTTP API Design Guide(譯:HTTP API 設(shè)計(jì)指南)
Some REST best practices
理解 RESTful 架構(gòu) - 阮一峰 簡(jiǎn)單了解什么是 RESTFul
RESTful API 設(shè)計(jì)指南 - 阮一峰
Restful API 的設(shè)計(jì)規(guī)范 實(shí)戰(zhàn)經(jīng)驗(yàn)的總結(jié),具有較強(qiáng)的啟發(fā)意義
撰寫安全合格的REST API 利用好 HTTP 協(xié)議所具備的特征
Web 服務(wù)編程,REST 與 SOAP REST 與傳統(tǒng)的面向服務(wù)的接口設(shè)計(jì)的區(qū)別,啟發(fā)性強(qiáng)
最佳實(shí)踐:更好的設(shè)計(jì)你的 REST API 了解 REST 實(shí)現(xiàn)緩存的過程
Thoughts on RESTful API Design
REST API Tutorial 全方位介紹 REST
HTTP 接口設(shè)計(jì)指北
Web API Design 接口就是開發(fā)人員提供的“界面”,用戶體驗(yàn)在接口設(shè)計(jì)上同樣重要,在線查看 2012 版、2013 版
知識(shí)碎片
理解 HTTP 冪等性 講得很清楚,推薦
淺析遠(yuǎn)程過程調(diào)用 RPC 告訴你什么是 RPC
httpstatuses 一眼看完所有常用的 HTTP 狀態(tài)碼,還可以看詳細(xì)含義
json-api 對(duì) API 應(yīng)該如何利用好 JSON 的一些建議
介紹 JSON 無論如何都應(yīng)該讀一遍
decision-graph.svg 一張大圖展示整個(gè) REST API 的驗(yàn)證過程,及各種狀態(tài)碼出現(xiàn)的時(shí)機(jī)
書籍
RESTful Web APIs 較新的一本書,對(duì) REST 做了很多系統(tǒng)性的總結(jié),尤其對(duì)“超媒體”作了詳細(xì)的介紹
Jersey-2.x-User-Guide(譯:Jersey 2.x 用戶指南)譯者也提供了入門簡(jiǎn)易教程 REST 實(shí)戰(zhàn)以及綜合實(shí)例 RestDemo(注:讀者需要 Java 基礎(chǔ))
REST CookBook 基礎(chǔ)介紹構(gòu)建 RESTful API
例子
Github API v3 被很多人參考和引用,比如對(duì)分頁的處理方法、接口版本的設(shè)計(jì)等等
Mailgun Documentation 郵件服務(wù) REST API
Enchant REST API
Coinbase API 設(shè)計(jì)的挺好的,包括官網(wǎng)提供的接口客戶端,都是具有參考意義的
OpenNMS Wiki ReST API
關(guān)于例子,實(shí)在是太多了,在有時(shí)間的時(shí)候,多觀察別人的設(shè)計(jì),有利于寫出好的 API。
調(diào)試工具
DHC (aka Dev HTTP Client) Chrome 插件,簡(jiǎn)單易用,可分類管理,界面友好。也很多人推薦 Postman
Fiddler2 抓包,捕捉每一次 REST 請(qǐng)求和響應(yīng)的詳細(xì)內(nèi)容
文檔制作
slate 創(chuàng)建的 API 文檔很好看,也很實(shí)用,三列式,目錄、調(diào)用說明和代碼示例同屏滾動(dòng)顯示。
i5ting_ztree_toc API 把 Markdown 文檔生成簡(jiǎn)單的 HTML API
代碼高亮
highlight.js 無需指定代碼是什么語言,直接按 TAB 鍵搞掂,它會(huì)自動(dòng)檢測(cè)高亮
PrismJS 高亮效果挺好看的
這方面的工具很多,可以自己在網(wǎng)上找找,找一款適合自己的就可以,畢竟只是工具,能達(dá)到目的就好。
社區(qū)
API Craft Google Group 有梯子才行
RESTful - 知乎 我也有作答~~
其他
MarkdownPad2 Window 下使用 Markdown 語法編寫文檔。等習(xí)慣了它的語法,可以直接使用任何一款文本編輯器直接寫了
總結(jié)
以上是生活随笔為你收集整理的restful-api-design-references的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Python 爬虫进阶二之 PySpid
- 下一篇: chrome插件开发详解