我正在编写 clojure rest 服务（带有 ring、compojure 和 liberator），并希望为我的所有 REST API 自动生成 API 文档。手动生成它非常繁琐。有没有办法使用注释或类似的东西？如果我能用 lein gen-rest-docs 来做会很酷。
问问题
1423 次
2 回答
5
REST 架构风格的“统一接口”属性不鼓励为单个端点编写文档。在 REST 中，您依靠自我描述的消息和超链接来驱动应用程序。
虽然我可以看到您需要记录您的 API，但我建议您专注于记录媒体类型如何应用于您的域以及实现中的一般假设。这通常包括授权、SLA。如果您正确使用媒体类型和超链接，则各个资源不再需要太多文档。
如果这不是您的选择，那么请注意您拥有 RPC 架构。在这种情况下， ring-swagger和类似的解决方案可以提供帮助。
于 2015-01-20T08:24:42.317 回答
2
尝试一下大摇大摆。它具有组合、fnhouse 和基座选项
于 2015-01-19T10:32:54.200 回答