Automating REST API documentation for routes [closed]

Question

Is it possible to automate the documentation of routes in a Spray application?

e.g. Is there perhaps an SBT plugin that generates markdown describing what it knows about the spray routes?

Ofilia

According groups.google.com/forum/#!topic/spray-user/0kxLzNRhnU4 there is not much available. All the solutions mentioned in that thread are declarative. – Heeley

Have you found a way to document your spray rest api? – Delfinadelfine

Answer 1

I stumbled upon spray-swagger while researching the same thing but I don't know exactly what it does and which stage the project is at.

Brolly

It works but imposes annoying requirement to rewrite your routes in such way that they're all methods (where as it's common for Spray apps to define routes as vals). It's because Swagger's ApiOperation annotation targets only methods. – Sere