CityOfPhiladelphia / carto-api-explorer

Generates API documentation for a dataset hosted on carto
https://cityofphiladelphia.github.io/carto-api-explorer/#incidents_part1_part2
2 stars 1 forks source link

Carto API Explorer

Generates API documentation for a dataset hosted on carto. Inspired by Socrata's API Foundry, this application queries Carto's API to get field names, types, and example values, then generates a page with usage examples and basic documentation.

Work in progress. View the demo.

Also note this is my (@timwis) first time using MobX so please let us know if there are any suggestions!

Usage

  1. Install dependencies via npm install or yarn install
  2. Copy .env.sample to .env and modify configuration as necessary
  3. Run a development server using npm start or yarn start
  4. Generate the documentation for a table by adding '/#' followed by the table name to the end of the URL. Example for a table called tabletest: /#tabletest