寧靜的API設計文件

Question

由於我的家庭作業的一部分，我不得不這樣做：

你需要給我們你將如何實現一個問題的REST API的在線商店設計文檔。它應該支持添加，刪除，編輯和搜索產品。你可以自由地承擔其他事情，但要確保你記錄下來。確保你已經考慮過認證之類的事情（只有經過認證的用戶才能添加/查看/編輯/刪除項目）。您正在爲將使用它創建移動應用程序的移動開發人員創建API。如果您還可以包含一些示例場景以及預期的請求/響應對象，那將會很棒。

我對平靜的api不熟悉，但現在已經閱讀了它們，並且很好地理解了所有基本原理。我只是不確定在上述問題中我需要做什麼？

我是不是要爲API提供這樣的代碼的網頁上，http://coreymaynard.com/blog/creating-a-restful-api-with-php/

或我沒有代碼，但我要解釋的英文代碼的執行？

還是我只需要說明資源，它們的表示，不同類型的uri的不同類型的操作以及相應的響應。

我理解REST，但我只是不確定是什麼這個問題已經問我做什麼？

RESTFUL API的設計文檔到底是什麼。

Answer 1

時在商業，設計文檔通常意味着你正在規劃功能的技術工藝/結構，你解釋的好處和可能的陷阱，等它真的很難告訴你的老師是否真的在談論這方面的API設計。大多數情況下，他可能希望你列出所有的API網址，並解釋每種方法的用途以及它們的功能。

機會，如果他指的RESTful API設計在後者的意義，那麼它很可能類似於Rails的是如何顯示自己的路線：