社區優秀文章
API 文檔神器 Swagger 介紹及在 PHP 項目中使用 - API 文檔撰寫方案
單個 Laravel 項目同時配置不同域名 api.domain(用戶端接口) 和 admin.domain(管理員端)
-
一套安全的 API 方案,第一步要做的事情就是部署 HTTPS
-
安全必讀。
開發 API 必讀文章
- 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 狀態碼,還可以看詳細含義
- json-api 對 API 應該如何利用好 JSON 的一些建議
- 介紹 JSON 無論如何都應該讀一遍
- decision-graph.svg 一張大圖展示整個 REST API 的驗證過程,及各種狀態碼出現的時機
現成 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 在線調試工具,點擊查看。
調試工具
- DHC (aka Dev HTTP Client) Chrome 插件,簡單易用,可分類管理,界面友好
- Fiddler2 Windows 下抓包必備,捕捉每一次 REST 請求和響應的詳細內容
- Charles Proxy Mac 下抓包必備
- Postman 功能齊全的 API 請求工具
Laravel API 課程
社區有一門實戰課程 《Laravel 教程實戰高級 - 構架 API 服務器》 ,主要專注於 App 和 SPA 後端 API 服務器實戰開發。手把手帶你構建一個設計合理的 RESTful API 服務器。本課程涉及的技術話題有:
- RESTFul 的概念及 Github Api 設計分解;
- DingoApi 的介紹及安裝;
- PostMan 的介紹及使用;
- 用戶認證 —— 手機註冊、登錄、退出;
- 第三方認證 —— 微信登錄、JWT 的使用;
- 用戶信息 —— 獲取個人信息、上傳圖片接口、修改個人信息;
- 話題接口 —— 發佈、修改、刪除、列表;
- 話題回覆接口 —— 發佈、修改、刪除、列表;
- 權限控制 —— 權限列表,角色列表;
- 資源推薦接口、活躍用戶接口;
- 接口本地化處理;
- API 接口錯誤代碼機制;
- APNS 消息推送服務器端介紹及實現;
- API 測試 —— 單元測試、集成測試、黑盒測試;
- 快速完成 API 文檔;
- Passport / OAuth 2.0 認證。