[davedx]

I've not seen this practice very much in my experience; most API's I've worked with go the "automated documentation generation" route and host the docs somewhere separate instead. This does mean you don't need tooling just to find out how to use the API.

This is distinct from throwing exceptions when an endpoint is called with e.g. invalid parameters.