Menu
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?
366
API documentation is a technical content deliverable, containing instructions about how to effectively use and integrate with an API.
API documentation is technical content that documents the API. It includes instructions on how to effectively use and integrate the API. It also provides updates on the API's lifecycle such as new versions or retirement. Some aspects of API documentation can be generated automatically via Swagger or other documents.
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))
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
