我使用clojure創建REST API。 如何自動生成REST文檔？

Question

我正在編寫clojure rest服務（帶有ring，compojure和liberator），並且想為我所有的REST API自動生成API文檔。 手動生成它非常繁瑣。 有沒有辦法使用注釋或類似的東西？ 如果我可以使用lein gen-rest-docs這樣做會很酷。

Answer 1

REST體系結構樣式的“ 統一接口”屬性不鼓勵使用各個端點的文檔。 在REST中，您依靠自我描述性消息和超鏈接來驅動應用程序。

雖然我看到您需要記錄您的API，但我建議重點關注記錄媒體類型如何應用於您的域以及實現中的一般假設。 這通常涵蓋授權，SLA。 如果您正確使用了媒體類型和超鏈接，則各個資源不再需要太多文檔。

如果那不是您的選擇，那么請注意您擁有RPC體系結構。 在這種情況下， 環形搖桿和類似的解決方案會有所幫助。

Answer 2

給環招搖一試。 它具有compojure，fnhouse和Pedestal選項