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

时间:2015-01-19 09:36:50

标签: rest clojure liberator

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

2 个答案:

答案 0 :(得分:3)

REST架构风格的" Uniform Interfaces"属性不鼓励单个端点的文档。在REST中,您依靠自描述性消息和超链接来驱动应用程序。

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

如果您没有选择,那么请注意您拥有RPC架构。在这种情况下,ring-swagger和类似的解决方案可以提供帮助。

答案 1 :(得分:2)

尝试ring-swagger。它有一个compojure,fnhouse和Pedestal选项