search

mattetti / Weasel-Diesel

DSL to describe, document and test web services
MIT License
438 stars 21 forks source link

API description / Meta-information #13

Open mikaa123 opened 12 years ago

mikaa123 commented 12 years ago

Hi! Thank you for the DSL/library; it's going to be incredibly useful to me and a lot of people.

Is there currently any way to describe the API as a whole (meta-information; such as what the API is intended to be used for, what are the different available processes, etc.)?

I think such information could prove valuable for middle to large APIs to see how the different 'services' fit together. What are your thoughts on it?

mattetti commented 12 years ago

That's a great idea. I'm not quite sure where that should live tho and that's probably why I was only providing end point specific documentation. Do you have a suggestion to provide more global documentation?