1. 首頁
  2. 問答
  3. 有據可查的RESTful服務示例

有據可查的RESTful服務示例

2011-02-08 48 views
55

我需要編寫RESTful服務的文檔。有沒有人知道一個非常好的RESTful服務文檔，我可以使用它作爲我自己的模板？有據可查的RESTful服務示例

謝謝。

來源

2011-02-08 Pablo

+1

你找到一個？如果你有這個問題，我很有興趣知道哪一個。 – 2013-11-11 09:37:16

+4

REST風格的服務不需要很好的書面文檔。 :) – 2014-03-01 23:36:57

+9

每個API都需要很好的書面文檔 – kralco626 2015-11-19 14:33:25

回答

0

Readability API最近在Twitter上受到好評。

披露：我是Arc90的成員，Readability的創造者和Readability的投資人。

來源

2011-02-08 21:00:52

2

API of CouchDB「這個」RESTful數據庫。

你會注意到文檔是由資源而不是由方法構造的，使得它比大多數衆所周知的API文檔更加面向資源。

來源

2014-01-16 06:43:00

1

嘗試rest-tool。

它遵循語言不可知的方法來編寫規範。爲現成的RESTful API提供即時模擬實現和自動化單元測試。

服務通過YAML文件指定，示例數據可以放在描述符旁邊。您可以找到一個JSON模式，以符合service.yml描述符文件的格式。這可以作爲一個guilde使用，但它可以根據需要擴展。

來源

2014-03-01 10:32:54 tombenke

12

您可以參考Zoho Subscriptions API文檔。這3列布局文檔由資源明智地構成，併爲每個端點提供樣本請求和響應。

披露：我是Zoho Subscriptions團隊的一員。

來源

2014-10-28 07:10:13

13

您是否聽說過http://swagger.io/？它爲REST API生成非常有用的（和很好的）文檔。

試試看。我真的推薦它。

來源

2015-07-23 22:30:08

44

請檢查REST API Documentation Best Practices文檔以記錄您的RESTful服務。該文件涵蓋了所有方面。這是它的一個片段。

標題：顯示所有用戶。
網址： /或用戶/用戶/：ID或/用戶ID =：ID
方法： GET | POST |刪除| PUT
網址參數：Required: ID = [整數]或者Optional: photo_id = [字母]
數據PARAMS： {U：{電子郵件：[字符串]名稱：[字符串]，current_password：[字母數字]密碼：[字母]，password_confirmation：[字母]}}
響應碼：成功（200 OK），錯誤請求（400），未經授權（401）

來源

2015-09-07 14:06:13 YoungHobbit

相關問題

 相關問題