接口的需求

• 支持get/post/put/delete
• 可以合并請求，一次請求多個接口。利于端減少請求。比如配置接口，一個配置接口，根據傳參取配置數(shù)據。
• 基于頁面和行為的接口規(guī)范。

資源。簡單資源的增刪改查。

• 項目/v1/資源，比如user/v1/user。
• user/v1/user。用戶列表
• user/v1/user/follow。關注的用戶列表。請求或響應和user/v1/user不同時，算一個新的資源。
• user/v1/user/{id}。某個用戶
• user/v1/user/{id}/small。某個用戶的簡要資料

什么時候需要頁面/行為接口。

• 性能問題。從多個資源取數(shù)據太慢。
• 事務問題。操作需要是原子性的，同時成功同時失敗，不能拆分成步驟。
• 安全和權限問題。有些數(shù)據有權限才能使用，而權限和頁面是關聯(lián)的。
• 頁面文案等配置。

頁面。單個頁面中混合了多個資源。

• 項目/v1/模塊/page/頁面，比如user/v1/user/page/index。
• 頁面的命名規(guī)范。
  • 首頁。index。
  • 列表頁。list。
  • 詳情頁。detail。
• 頁面文案配置。
  • 在移動端或PC端等客戶端，為了不發(fā)版就改變端的頁面，需要通過接口配置端的內容。
  • 在手工位由端開發(fā)人員添加json配置，通過頁面接口或者端配置接口獲取。
  • 端配置接口，允許獲取配置中心這個端的所有配置。

行為，事件。一個行為觸發(fā)對很多資源的操作。

• 項目/v1/模塊/event/行為名。比如user/v1/user/event/login。

文檔。

• 域名。
• 通用參數(shù)。
• 請求URL
• 請求方法
• 請求參數(shù)。字段/類型/是否必須/說明
• 請求示例
• 響應字段。字段/類型/說明
• 響應示例