Documenting REST services
Documenting REST services
- Subject: Documenting REST services
- From: Pascal Robert <email@hidden>
- Date: Wed, 27 Oct 2010 11:19:41 -0400
I have to document some new REST services so that the people who will use them can see the names and types of attributes, which non-routes are available. Part of the documentation will be auto-generated with the help of the JSON Schema stuff that was added in ERRest, which will at least generate the attributes list for each route. But it would be cool to generate more, for example to generate a summary of what the route is for, or explaining what a specific attribute is (for case where the attribute name is not clear).
For people who use ERRest, what do you use to provide documentation to people who are using your services? Javadoc?
--
Pascal Robert
email@hidden
AIM/iChat : MacTICanada
LinkedIn : http://www.linkedin.com/in/macti
Twitter : pascal_robert
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden