This article asserts that the OPTIONS method of a JSON+REST should return structured documentation for that resource. I like this idea. I’ve been searching for ways for API documentation to stay close to the code, and this looks promising. I would like it if the zeroth-level documentation could contain the same basic content that automated WADL generators (like what Apache CXF provides) can extract via reflection, and let the developers add on to that in natural ways.
Originally shared by Abraham Williams
The HTTP OPTIONS method and potential for self-describing RESTful APIs