Generate RAML automatically

mmcardle / django_builder

Django Builder Site

MIT License

607 stars 126 forks source link

Generate RAML automatically #35

Open durm opened 7 years ago

durm commented 7 years ago

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

mmcardle commented 7 years ago

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?

durm commented 7 years ago

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.