Metarpheus sifts through scala source files and extracts models (represented in scala as case classes) and specifically formatted spray routes (marked with @publishroute). At the current stage, it will output a json-based representation of models and APIs that can be subsequently transformed in:
- javascript type definition (e.g. flow, tcomb)
- language-agnostic representation (e.g. Swagger)
- human-readable API documentation
Refer to the tests for examples of the required spray route formatting. More extensive documentation is a work in progress (along with an effort of open-sourcing our internal set of conventions and support libraries for spray-based servers).
See also this README