• These docs are auto-deployed to Github Pages by the Travis build: https://travis-ci.org/wxtiles/wxtiles-docs
• The build publishes the docs to the github.com/wxtiles/wxtiles.github.io repo.
• html files are not committed because we build them from shmtl.
• use npm run build-docs to build the html and js files locally.

The docs can be found at: https://wxtiles.github.io

API Docs

Swagger-ui based API documentation is found in the api-docs directory.

Go here https://wxtiles.github.io/api-docs/

API Docs Testing

The tests directory contains a node project based on apispots-testing-bdd. Apispots-testing-bdd (and not the rest of this repository) is MIT licensed. See the tests/LICENSE for details.

The build command:

npm run build-swagger

Will now run the tests before running the build. The tests will run against the production api by default. To change this you must set an environment variable. See the tests README for details.

If you want to run just the tests you can run:

npm test

Code-Gen

The yaml file found at swagger-definitions/swagger.yaml is the source of truth for these api docs.

To run the swagger code generator (for swagger.json):

npm run build-swagger-json

To run the swagger code generator (for javascript):

npm run build-swagger-js-client

To run the swagger code generator (for both):

npm run build-swagger

Swagger code generator from here: https://github.com/swagger-api/swagger-codegen

Dev Requirements

####Tests The tests require ES6 support. I have only tested them in Node v6 so that is probably the best bet.

####Build Swagger Building the JSON version of the swagger uses Swagger CodeGen which requires a Java 7 runtime.