search

lmco / streamflow

StreamFlow™ is a stream processing tool designed to help build and monitor processing workflows.
https://github.com/lmco/streamflow/wiki
Apache License 2.0
253 stars 69 forks source link

Document public REST API #19

Open juliencruz opened 9 years ago

juliencruz commented 9 years ago

Javadoc comments need to be developed for all API worthy classes. REST documentation should be included in this Javadoc documentation to produce REST API documentation.

jloveland commented 9 years ago

What do you think about swagger or enunciate?

I like the look of swagger because it provides a nice UI and Editor

juliencruz commented 9 years ago

I have seen some docs before from Swagger and would like to use that if possible. Shouldn't be too difficult to add these in.