從Restlet註釋生成REST API文檔

RESTful Web服務API使用Restlet實現。我需要爲這些生成API文檔。我不是從一個單獨的文檔開始，而是評估這是否可以從源代碼註釋本身生成。從Restlet註釋生成REST API文檔

我看着Swagger併發聲。 Swagger似乎基於JAX-RS規範。 Enunciate看起來更有希望，因爲有一個FAQ提到了如何爲非JAX-RS實現生成，但沒有任何幫助。

2012-11-21 Srini

即將開始的東西就這樣。想知道你是否找到了解決方案？您是否調查了WADL擴展（http://wiki.restlet.org/docs_2.0/13-restlet/28-restlet/72-restlet.html）？ –

我找不到任何合適的東西可以集成。我曾嘗試發表聲明，但由於註解衝突而無法使其生成文檔。我終於使用Sphinx並創建了一個很好的文檔。 – Srini

Restlet的Swagger擴展已經完成了一些工作：https：//github.com/restlet/restlet-framework-java/issues/595 –

Restlet現在支持在運行時基於您的應用程序生成相應的Swagger和RAML內容的功能。

以下文檔可以幫助您：

然後您可以利用工具從工具社區來生成你的API文檔。您可以考慮Swagger UI，這是一個很棒的工具，可以在線顯示API提供的內容並與之交互。

希望它可以幫助你，蒂埃裏

2015-06-15 07:55:39

回答