django_builder icon indicating copy to clipboard operation
django_builder copied to clipboard

Generate RAML automatically

Open durm opened this issue 8 years ago • 2 comments

it would be grate to generate RAML automatically on /doc endpoint, for example.

durm avatar Sep 12 '17 15:09 durm

Hi, This sounds like an interesting idea, I haven't worked that much with RAML, do you have any examples of what you would expect from such a feature?

mmcardle avatar Sep 13 '17 07:09 mmcardle

Unfortunatelly, I've not working example. But the goal is to have already documented rest endpoints with input/output schema specification, possible returning statuses declaration and examples as well. Having those documentation any-one can easilly start to using your rest api w/o understanding how it was imlenented. Just with taking look at the doc.

durm avatar Sep 14 '17 05:09 durm