我正在使用WcF身份驗證服務創建WCF Web服務,我需要的第一組功能是管理客戶端的收件箱。客戶端將由認證確定。我是否正確設計了這個WCF RESTful接口?
這是我嘗試在API的REST風格的設計:
https://api.mydomain.com/v1/inbox/messages (GET)
返回收件箱中的結果的一個頁面,一個可選的搜索過濾器應用於
- 計數 - 每頁記錄數
- 頁碼 - 起始於
- 排序 - (可選)字段進行排序
- 搜索 - (可選)要搜索的文本
https://api.mydomain.com/v1/inbox/mark (POST)
標記一個或多個消息已讀或未讀
- 操作 - MarkRead或MarkUnread
- MessageIDs - 要標記的消息ID列表
https://api.mydomain.com/v1/inbox/archive (POST)
檔案館一個或多個消息
- MessageIDs - 消息ID列表存檔
我這樣做對嗎?如果不是,那麼設計此接口的更好方法是什麼?
聽起來像讀和未讀可以成爲你的第二個網址的一部分? 'https:// api.mydomain.com/v1/inbox/mark/read'和'https:// api.mydomain.com/v1/inbox/mark/unread' –
它們應該是兩個單獨的函數還是一個函數的參數(這在RESTful API中更常見)? – Jason
如果你按照我的建議做,那麼這將是兩個終點是正確的?如在兩個URL中。但系統可以用相同的方法處理它們。 –