Search code examples
scalarestplayframework-2.0documentation-generation

Are there any plugins for generating API documentation for Play 2.x?


We have a relatively large REST API build on top of Play 2.x and are tasked with documenting it for our internal users. Since it is our belief that maintaining this on a separate wiki is very difficult, we are wondering if there are any documentation generating tools out there for Play?


Solution

  • Swagger provides Play 2 support:

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

    Play 2 itself provides documentation to its router in a convenient format, checkout what happens when you call:

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