我使用clojure创建RESTAPI。如何自动生成REST文档?

我使用clojure创建RESTAPI。如何自动生成REST文档?,rest,clojure,liberator,Rest,Clojure,Liberator,我正在编写clojure rest服务(使用ring、compojure和liberator),并希望为我的所有rest API自动生成API文档。手动生成它是非常繁琐的。有没有办法使用注释或类似的东西?如果我能用lein gen rest docs来做,那就太酷了。试试看。它具有compojure、fnhouse和底座选项。REST体系结构样式的“属性”不鼓励为各个端点编写文档。在REST中,您依赖自描述性消息和超链接来驱动应用程序 虽然我可以看出您需要记录API,但我建议您将重点放在记录媒体

我正在编写clojure rest服务(使用ring、compojure和liberator),并希望为我的所有rest API自动生成API文档。手动生成它是非常繁琐的。有没有办法使用注释或类似的东西?如果我能用lein gen rest docs来做,那就太酷了。

试试看。它具有compojure、fnhouse和底座选项。REST体系结构样式的“属性”不鼓励为各个端点编写文档。在REST中,您依赖自描述性消息和超链接来驱动应用程序

虽然我可以看出您需要记录API,但我建议您将重点放在记录媒体类型如何应用于您的域以及实现中的一般假设上。这通常包括授权、SLA。如果您正确使用媒体类型和超链接,则单个资源不再需要太多文档e


如果您没有选择,那么请注意您有一个RPC体系结构。在这种情况下,类似的解决方案会有所帮助。

您能否详细说明如何使用该体系结构生成文档?根据您使用的库,您将在其项目页面上找到一个示例。例如,对于compojure,请参阅。指向每个库的链接都在环招摇过市中pageI明白了。如果我想记录服务器响应(json),我应该使用swagger,不是吗?我为前端开发人员提供了一个特殊的wiki页面,其中包含所有不明显响应的示例。主要问题是必须同时支持代码库和wiki页面。