Document API endpoints

[kmcurry]

As a Developer, I want to know the names/routes and purposes of the API's endpoint so that I can understand what's available and how to use it.

Create documentation for each of the endpoints.

Essential documentation is each url, its purpose in plain language, parameters, if any, and definition of results. Ideal documentation has working examples.

Example:

/crime/:cities

Returns crime data for the given, comma separated list of one or more cities. Append the url with .format to return the result in that format.

Examples:
/crime/VirginiaBeach.json
/crime/Hampton,VirginiaBeach,Norfolk.csv

Result is paged with a default page size of 500 records. When multiple cities are queried results are evenly divided up to the page size.

[hop-along-polly]

Is this enough documentation?

[kmcurry]

To clarify:
What is the plain language definition of this endpoint?
http://hercules.code4hr.org/schools

And what are the other endpoints and their plain language definitions?
http://hercules.code4hr.org/crime/Hampton

Documentation should also cite sources and methods of transformation, i.e., what you did to the source data.

[kmcurry]

I started this: https://github.com/Code4HR/hercules/wiki/Catalog