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?
Asked
Active
Viewed 1,757 times
10
-
2According https://groups.google.com/forum/#!topic/spray-user/0kxLzNRhnU4 there is not much available. All the solutions mentioned in that thread are declarative. – Arnaud Gourlay Apr 09 '13 at 13:40
-
Have you found a way to document your spray rest api? – dirceusemighini Jan 17 '14 at 10:33
1 Answers
3
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.
Giovanni Botta
- 8,996
- 5
- 45
- 88
-
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 `val`s). It's because Swagger's `ApiOperation` annotation targets only methods. – expert Jan 20 '15 at 16:08