Currently we maintain API docs for the REST service manually in the GitHub wiki:
https://github.com/JeffersonLab/myquery/wiki/API-Reference
Ideally, the web service endpoint docs are generated automatically. Would require finding some tooling. Perhaps something along the lines of https://github.com/stoicflame/enunciate. It's possible javadoc paired with JAX-RS annotations could work, but we don't use JAX-RS at the moment. See Also: WADL.
Currently we maintain API docs for the REST service manually in the GitHub wiki:
https://github.com/JeffersonLab/myquery/wiki/API-Reference
Ideally, the web service endpoint docs are generated automatically. Would require finding some tooling. Perhaps something along the lines of https://github.com/stoicflame/enunciate. It's possible javadoc paired with JAX-RS annotations could work, but we don't use JAX-RS at the moment. See Also: WADL.