是否可以自動生成由ServiceStack創建的REST API的良好文檔？

現有工具可用於自動生成API文檔 - 大部分工具不是爲REST服務設計的。是否可以自動生成由ServiceStack創建的REST API的良好文檔？

對於所有使用ServiceStack創建REST服務的人 - 您是如何編寫文檔的？手動/半自動/全自動生成？我甚至在考慮汽車代定製WADL，它像apigee連接東西Console To Go

（OH和RESTafaries-請饒了「REST API應該是自動發現和自我解釋的」口頭禪......我真想漂亮的文檔爲我的用戶）。

2012-08-23 Froyke

嗨Froyke。請參閱我的評論http://stackoverflow.com/a/22939360/214747，以獲取建議的文檔ServiceStack Web服務的方法。 – Christo

謝謝，但這並沒有那麼直觀的吸引力，不太方便用戶。在一天結束時，我手動創建了一個使用XSLT轉換爲漂亮HTML的WADL文件。在這裏看到它的行動：http://developer.dome9.com/reference.html我也喜歡Apigee的控制檯，所以相同的WADL文件可以喂他們的控制檯：https：//apigee.com/froyke/embed/console/dome9 – Froyke

通過XHTML記錄API可能會提供比格式化DTO更好的結果。看看http://www.amundsen.com/blog/archives/1043和這個鼓舞人心的video。

來源

2012-08-27 20:24:23

是否可以自動生成由ServiceStack創建的REST API的良好文檔？

回答

相關問題