RESTful API 設計參考文獻列表

來自： http://segmentfault.com/a/1190000004353103

之所以創建這個 repository，是因為我希望收集一些比較好的有關于 RESTful API 設計的參考文獻。偶爾回顧，偶爾改進，大家一起來吧~

如果你有更好的私藏文章，不凡分享出來，獨樂樂不如眾樂樂，(⊙o⊙)

RESETful 介紹及設計思路

1. Principles of good RESTful API Design（譯：好 RESTful API 的設計原則 ）簡單易懂，條理清晰，推薦

2. Best Practices for Designing a Pragmatic RESTful API（譯：RESTful 最佳實踐 譯文2）有實際的案例 Enchant

3. HTTP API Design Guide（譯：HTTP API 設計指南）

4. Some REST best practices

5. 理解 RESTful 架構 - 阮一峰 簡單了解什么是 RESTFul

6. RESTful API 設計指南 - 阮一峰

7. Restful API 的設計規范 實戰經驗的總結，具有較強的啟發意義

8. 撰寫安全合格的REST API 利用好 HTTP 協議所具備的特征

9. Web 服務編程，REST 與 SOAP REST 與傳統的面向服務的接口設計的區別，啟發性強

10. 最佳實踐：更好的設計你的 REST API 了解 REST 實現緩存的過程

11. Thoughts on RESTful API Design

12. REST API Tutorial 全方位介紹 REST

13. HTTP 接口設計指北

知識碎片

1. 理解 HTTP 冪等性 講得很清楚，推薦

2. 淺析遠程過程調用 RPC 告訴你什么是 PRC

3. httpstatuses 一眼看完所有常用的 HTTP 狀態碼，還可以看詳細含義

4. json-api 對 API 應該如何利用好 JSON 的一些建議

5. 介紹 JSON 無論如何都應該讀一遍

6. decision-graph.svg 一張大圖展示整個 REST API 的驗證過程，及各種狀態碼出現的時機

書籍

1. RESTful Web APIs 較新的一本書，對 REST 做了很多系統性的總結，尤其對“超媒體”作了詳細的介紹

2. REST 實戰 基于 Jersey 構建 RESTful 服務，有實際的案例 RestDemo（我注：讀者需要懂一些 Java ）

3. Jersey 2.x 用戶指南 該書是 Java REST 的規范實現之一 Jersey 用戶手冊，中文翻譯（我注：讀者需要懂一些 Java ）

例子

1. Github API v3 被很多人參考和引用，比如對分頁的處理方法、接口版本的設計等等

2. Mailgun Documentation 郵件服務 REST API

3. Enchant REST API

4. Coinbase API 設計的挺好的，包括官網提供的接口客戶端，都是具有參考意義的

5. OpenNMS Wiki ReST API

關于例子，實在是太多了，在有時間的時候，多觀察別人的設計，有利于寫出好的 API。

調試工具

1. DHC (aka Dev HTTP Client) Chrome 插件，簡單易用，可分類管理，界面友好。也很多人推薦 Postman

2. Fiddler2 抓包，捕捉每一次 REST 請求和響應的詳細內容

文檔制作

1. slate 創建的 API 文檔很好看，也很實用，三列式，目錄、調用說明和代碼示例同屏滾動顯示。

2. i5ting_ztree_toc API 把 Markdown 文檔生成簡單的 HTML API

代碼高亮

1. highlight.js 無需指定代碼是什么語言，直接按 TAB 鍵搞掂，它會自動檢測高亮

2. PrismJS 高亮效果挺好看的

這方面的工具很多，可以自己在網上找找，找一款適合自己的就可以，畢竟只是工具，能達到目的就好。

社區

1. API Craft Google Group 有梯子才行

2. RESTful - 知乎 我也有作答~~

其他

1. MarkdownPad2 Window 下使用 Markdown 語法編寫文檔。等習慣了它的語法，可以直接使用任何一款文本編輯器直接寫了