Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document public REST API #19

Open
juliencruz opened this issue Nov 29, 2014 · 2 comments
Open

Document public REST API #19

juliencruz opened this issue Nov 29, 2014 · 2 comments

Comments

@juliencruz
Copy link
Contributor

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
Copy link

What do you think about swagger or enunciate?

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

@juliencruz
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants