scala - 是否有任何插件可以为 Play 2.x 生成 API 文档?

标签 scala rest playframework-2.0 documentation-generation

我们在 Play 2.x 之上构建了一个相对较大的 REST API,并负责为我们的内部用户记录它。由于我们认为在单独的 wiki 上维护它非常困难,我们想知道是否有任何用于 Play 的文档生成工具?

最佳答案

Swagger 提供 Play 2 支持:

https://github.com/swagger-api/swagger-play

Play 2 本身以方便的格式为其路由器提供文档,查看调用时会发生什么:

Play.current.routes.foreach(r => println(r.documentation))

关于scala - 是否有任何插件可以为 Play 2.x 生成 API 文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/20251105/

相关文章:

rest - REST 适合 Web 应用程序吗?

scala - 如何以编程方式将 Play 2.4 模块的执行限制到单个主机?

java - Play Framework 在使用空值的 Web 服务调用期间从 URL 中剥离 "="(导致结束点出现 500 错误)

scala - 比较两个列表中的项目

scala - 我可以使用 Scala 宏来内部化外部 DSL 吗?

scala - 让 `f =` 移动到 => 或 ⇒

scala - 使用 shadowJar 和 Scala 依赖项时如何修复丢失的 conf 文件?

ajax - 修改 AJAX 应用程序中的地址栏 URL 以匹配当前状态

java - ServletContext 参数 : are they per instance or per server?

具有隐式参数的 Scala 设计模式(在 Scala 中 Play 2.x)