Data Together API is a JSON api for all of Data Together's centralized services. Full documentation of the API is on the server itself by running the server & visiting the /docs/
endpoint. More instructions in the Usage section below.
Copyright (C) 2017 Data Together This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.0.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the LICENSE
file for details.
We would love involvement from more people! If you notice any errors or would like to submit changes, please see our Contributing Guidelines.
We use GitHub issues for tracking bugs and feature requests and Pull Requests (PRs) for submitting changes
If you have docker & docker-compose, clone this repo & run the following:
# first, cd into the project directory, then run
docker-compose up
# this should take you to the api documentation:
http://localhost:8080/docs/
The Data Together API is documented using the Open API Specification,
All API documentation is generated from the open_api.yaml
file, to update docs:
- Install spectacle
- Dev with
spectacle -d open_api.yaml
, editingopen_api.yaml
to make changes - Generate Static docs with
spectacle open_api.yaml
- Commit. Rinse. Repeat.
[Step-by-step instructions about how to set up a local dev environment and any dependencies]
[Optional section with deployment instructions]