Scala 有没有插件可以为Play2.x生成API文档?
我们在Play2.x上构建了一个相对较大的RESTAPI,并负责为内部用户编写文档。由于我们认为在单独的wiki上维护这一点非常困难,我们想知道是否有任何用于播放的文档生成工具?Swagger提供播放2支持: Play 2本身以一种方便的格式向其路由器提供文档,检查您呼叫时发生的情况:Scala 有没有插件可以为Play2.x生成API文档?,scala,rest,playframework-2.0,documentation-generation,Scala,Rest,Playframework 2.0,Documentation Generation,我们在Play2.x上构建了一个相对较大的RESTAPI,并负责为内部用户编写文档。由于我们认为在单独的wiki上维护这一点非常困难,我们想知道是否有任何用于播放的文档生成工具?Swagger提供播放2支持: Play 2本身以一种方便的格式向其路由器提供文档,检查您呼叫时发生的情况: Play.current.routes.foreach(r => println(r.documentation)) 我猜,在游戏2.4中,您将注入路由器: class Health @Inject
Play.current.routes.foreach(r => println(r.documentation))
我猜,在游戏2.4中,您将注入路由器:
class Health @Inject() (router: Router) extends Controller {
def doc = Action { implicit request =>
val myroutes = router.documentation.map {
x => Json.obj("http_method" -> x._1, "path" -> x._2, "scala" -> x._3)
}
Ok(Json.obj("k" -> myroutes))
}
}
但是,这并不是一个好的API文档。你没有得到,你必须发布什么东西,或者你会得到什么东西
仍然在想,是否有更好的方法让REST-API文档退出使用…我现在正在使用raml。
没有自动生成api文档。您必须手动创建和更改api文档,但这一点也不错。
当然,如果您更改了api,您也必须记住更改api文档;这是一个失败点
但好处是:您不会用注释和api文档注释污染代码。这对我来说是最重要的一点。
“api文档语言”非常容易学习/使用