REST文檔模板

2012-07-25 99 views 4 likes

我正在編寫自己的RESTful API，並且希望在我繼續時記錄它。我想知道是否有人有任何建議可以幫助文檔處理的工具？我不在尋找能夠基於閱讀源代碼或任何大而健壯的東西來自動生成文檔的東西。REST文檔模板

我真的在尋找某種HTML主題，它可以很好地顯示信息，甚至可以很好地佈局文檔，因爲我不介意提供所有信息。

有什麼建議嗎？

2012-07-25 ackerchez

可能重複的[記錄REST服務]（http://stackoverflow.com/questions/1904266/documenting-a-rest-service） – 2012-07-25 08:45:58

它不是一個重複的，我看到了這個問題，答案開始標題在一個完全不同的方向。我只是想知道是否有人遇到了一個良好的HTML或Wordpress模板來佈置文檔。 – ackerchez 2012-07-25 10:05:56

回答

一些人正在手動編寫swagger-spec文檔，並使用swagger-ui作爲文檔。你可以在沒有服務器集成的情況下做到這一點，它爲你的用戶提供了一個很好的參考。

更新：我推了一個swagger示例，其中有沒有服務器集成，除了web服務器作爲容器的swagger UI和spec文件。看到the swagger-core no-server sample

2012-08-23 05:23:36 fehguy

這真的很有用。謝謝！ – 2013-01-09 19:07:45

相關問題