[API] 常用 API 命名


開發 API 經常會遇到想不出有甚麼可以用的英文名稱,
以下列出一些範例示範使用 GET/ POST/ PUT/ DELETE 方法操作。
 

常用 API 命名方式

商品

方法 命名 說明
GET /store/inventory 返回商品庫存量
POST /store/order 下訂單
GET /store/order/{orderId} 透過 ID 找尋採購訂單單號
DELETE /store/order/{orderId} 透過 ID 刪除採購訂單單號
 

使用者

方法 命名 說明
POST /user 建立新使用者
POST /user/createWithArray 使用陣列的方式新增多筆使用者
POST /user/createWithList 使用列表的方式新增多筆使用者
GET /user/login 使用者登入
GET /user/logout 使用者登出
GET /user/{username} 經由使用者帳號取得該使用者資料
PUT /user/{username} 經由使用者帳號更新該使用者資料
DELETE /user/{username} 經由使用者帳號刪除該使用者資料



 

回上一頁

相關文章:

喜歡這篇文章嗎?立即分享

Posted : / Views: 262
Last updated :2017-11-30