一個HTTP接口的結構通常為 協議://域名/應用content path/自定義路徑?查詢參數
以下給出一些定義接口的建議
一、域名相關
若域名無法區分出是api還是頁面功能的時候,api路徑后面統一加上/api用於區分是接口服務。
例如 http://bos3d.bimwinner.com/api/test/files 為向test數據庫上傳文件。
二、詞性相關
使用名詞的復數形式定義資源,動詞詞性使用下划線區分。
GET/users/{userId} //查看某個具體用戶的信息
POST/users //新建一個用戶
PUT/users/{userId} //全量更新一個用戶的信息
GET/users/_serch //搜索用戶
POST/users/_init //初始化所有用戶
備注:批量操作時統一使用POST作為http method;URL對大小寫敏感,通常規定使用小寫