我使用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选项