Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.41 KB

readme.md

File metadata and controls

60 lines (38 loc) · 2.41 KB
Raw

Data Together JSON API

GitHub Slack License Codecov

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.

License & Copyright

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.

Getting Involved

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

Usage

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/

API Documentation

The Data Together API is documented using the Open API Specification,

Generating Documentation

All API documentation is generated from the open_api.yaml file, to update docs:

  1. Install spectacle
  2. Dev with spectacle -d open_api.yaml, editing open_api.yaml to make changes
  3. Generate Static docs with spectacle open_api.yaml
  4. Commit. Rinse. Repeat.

Development

[Step-by-step instructions about how to set up a local dev environment and any dependencies]

Deployment

[Optional section with deployment instructions]