让Swagger在Play2应用程序中工作斯卡拉

我试图让Swagger在Play2应用程序中工作。我已经在build.sbt中加入了依赖。 "com.wordnik" %% "swagger-play2" % "1.3.1" 我已经定义了一系列路线。让Swagger在Play2应用程序中工作斯卡拉

GET  /api-docs     controllers.ApiHelpController.getResources 
GET  /api-docs/building   controllers.ApiHelpController.getResource(path = "/building") 
GET  /building     controllers.Application.building

我也有一个模型，从Slick中提取数据，并有注释。

package models 

import scala.slick.driver.SQLServerDriver.simple._ 
import play.api.libs.json._ 
import play.api.db.DB 
import play.api.Play.current 
import Database.threadLocalSession 

@XmlRootElement(name = "Building") 
case class Building(@XmlElement(name = "BuildingCode") BuildingCode: String, 
        @XmlElement(name = "BuildingDescription") BuildingDescription: String) 

object Building { 

    lazy val database = Database.forDataSource(DB.getDataSource()) 
    implicit val BuildingReads = Json.reads[Building] 
    implicit val BuildingWrites = Json.writes[Building] 

    val BuildingTable = new Table[Building]("building"){ 
    def BuildingCode = column[String]("BuildingCode", O.PrimaryKey) 
    def BuildingDescription = column[String]("BuildingDescription") 
    def * = BuildingCode ~ BuildingDescription <> (Building.apply _, Building.unapply _) 
    } 

    def getAll: Seq[Building] = { 
    database withSession { 
     val q = Query(BuildingTable) 
     q.list 
    } 
    } 
}

这是我的控制器的样子。

object Application extends Controller { 

    def building = Action { 
    Ok(Json.toJson(Building.getAll)) 
    } 

}

当我浏览到/ API的文档的页面呈现。

{"apiVersion":"beta","swaggerVersion":"1.2"}

然后，如果我导航到/ api-docs/building，则不呈现任何内容。最后，当我导航到/建立我收到有效载荷。我不确定我还需要做什么来让Swagger生成它的数据。有人能指引我朝着正确的方向吗？

来源

2013-11-22 rross

你可以发布你的控制器实现吗？错误很可能是由于缺少/不正确的注释。

此外，检查出https://github.com/wordnik/swagger-core/tree/master/samples/scala-play2为一个很好的示例play2-swagger应用程序。

来源

2013-11-25 12:54:47 josephpconley

我刚刚在上面添加了我的控制器实现。 – rross

我相信你需要在控制器的顶层添加注释，并为每个你想要记录的方法添加注释。您还需要确保路由文件中定义了“/ api-docs/building”的路由。看看我发布的示例应用程序的链接，以获取如何执行这些操作的指导 – josephpconley

让Swagger在Play2应用程序中工作斯卡拉

回答

相关问题