RESTful API 設計參考文獻列表，可幫助你更加徹底的瞭解REST風格的接口設計。
restful
rest-api
rest
restful-api
restapi
33 commits
2 branches
0 packages
0 releases
4 contributors
MIT
@aisuhua
aisuhua Update README.md
Latest commit
86c625b
on 10 Jun 2018
Type Name Latest commit message Commit time
Architectural Styles and the Design of Network-based Software Architectures.pdf add architectural 5 years ago
LICENSE Initial commit 5 years ago
README.md Update README.md 2 years ago
api-design-ebook-2012-03.pdf 添加 “Web API Design” 2012,2013 兩個 pdf 文件 4 years ago
ebook-2013-03-wad.pdf 添加 “Web API Design” 2012,2013 兩個 pdf 文件 4 years ago
內網API設計風格對比分析.pptx 新增“內網API設計風格對比分析.pptx” 4 years ago
架構風格與基於網絡的軟件架構設計.pdf add architectural 5 years ago
README.md
之所以創建這個 repository，是因爲我希望收集一些比較好的有關於 RESTful API 設計的參考文獻。偶爾回顧，偶爾改進，大家一起來吧~
如果你有更好的私藏文章，不凡分享出來，獨樂樂不如衆樂樂，(⊙o⊙)
RESTful 介紹及設計思路
Principles of good RESTful API Design（譯：好 RESTful API 的設計原則 ）簡單易懂，條理清晰，推薦
Best Practices for Designing a Pragmatic RESTful API（譯：RESTful 最佳實踐 譯文2）有實際的案例 Enchant
HTTP API Design Guide（譯：HTTP API 設計指南）
Some REST best practices
理解 RESTful 架構 - 阮一峯 簡單瞭解什麼是 RESTFul
RESTful API 設計指南 - 阮一峯
Restful API 的設計規範 實戰經驗的總結，具有較強的啓發意義
撰寫安全合格的REST API 利用好 HTTP 協議所具備的特徵
Web 服務編程，REST 與 SOAP REST 與傳統的面向服務的接口設計的區別，啓發性強
最佳實踐：更好的設計你的 REST API 瞭解 REST 實現緩存的過程
Thoughts on RESTful API Design
REST API Tutorial 全方位介紹 REST
HTTP 接口設計指北
Web API Design 接口就是開發人員提供的“界面”，用戶體驗在接口設計上同樣重要，在線查看 2012 版、2013 版
架構風格與基於網絡應用軟件的架構設計 原汁原味的博士論文，由李錕翻譯，有經驗的同學可以挑戰一下
Microsoft REST API Guidelines 微軟官方的 REST API 設計指南，值得參考
知識碎片
理解 HTTP 冪等性 講得很清楚，推薦
淺析遠程過程調用 RPC 告訴你什麼是 RPC
httpstatuses 一眼看完所有常用的 HTTP 狀態碼，還可以看詳細含義
List of HTTP status codes From Wikipedia
HTTP Status Codes From MSDN Microsoft
List of HTTP header fields
json-api 對 API 應該如何利用好 JSON 的一些建議
介紹 JSON 無論如何都應該讀一遍
decision-graph.svg 一張大圖展示整個 REST API 的驗證過程，及各種狀態碼出現的時機
書籍
RESTful Web APIs 較新的一本書，對 REST 做了很多系統性的總結，尤其對“超媒體”作了詳細的介紹
Jersey-2.x-User-Guide（譯：Jersey 2.x 用戶指南）譯者也提供了入門簡易教程 REST 實戰以及綜合實例 RestDemo（注：讀者需要 Java 基礎）
REST CookBook 基礎介紹構建 RESTful API
例子
Github API v3 被很多人蔘考和引用，比如對分頁的處理方法、接口版本的設計等等
Mailgun Documentation 郵件服務 REST API
Enchant REST API
Coinbase API 設計的挺好的，包括官網提供的接口客戶端，都是具有參考意義的
OpenNMS Wiki ReST API
REST API 使用詳解 Lean Cloud 中講解 REST API 的使用，還集成 Swagger UI 在線調試工具，點擊查看。
關於例子，實在是太多了，在有時間的時候，多觀察別人的設計，有利於寫出好的 API。
調試工具
DHC (aka Dev HTTP Client) Chrome 插件，簡單易用，可分類管理，界面友好。也很多人推薦 Postman
Fiddler2 抓包，捕捉每一次 REST 請求和響應的詳細內容
文檔製作
slate 創建的 API 文檔很好看，也很實用，三列式，目錄、調用說明和代碼示例同屏滾動顯示。
i5ting_ztree_toc API 把 Markdown 文檔生成簡單的 HTML API
代碼高亮
highlight.js 無需指定代碼是什麼語言，直接按 TAB 鍵搞掂，它會自動檢測高亮
PrismJS 高亮效果挺好看的
這方面的工具很多，可以自己在網上找找，找一款適合自己的就可以，畢竟只是工具，能達到目的就好。
社區
API Craft Google Group 有梯子纔行
RESTful - 知乎 我也有作答~~
其他
MarkdownPad2 Windows 下使用 Markdown 語法編寫文檔。等習慣了它的語法，可以直接使用任何一款文本編輯器直接寫了