Serves the Data Together JSON API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci add support for codecov.io Oct 25, 2017
.github
Godeps
apiutil
docs
public
sql
vendor
.gitignore
Dockerfile
LICENSE
README.md
auth.go
collection_handlers.go
collections_requests.go
config.go
coverage_handlers.go
custom_crawl_handlers.go
custom_crawl_requests.go
docker-compose.yml
handlers.go
main_test.go
middleware.go prep for org switch Jun 28, 2017
open_api.yaml
primer_handlers.go
primer_requests.go
repository_handlers.go
server.go
server_test.go
source_handlers.go
source_requests.go
transports.go
uncrawlable_handlers.go
uncrawlable_requests.go
url_handlers.go
url_requests.go
user_handlers.go prep for org switch Jun 28, 2017

README.md

Data Together API

GitHub Slack License

Serves the Data Together JSON API.

This component in isolation doesn't do much, but when connected to the project as a whole it provides a variety of endpoints over https, which can be used to extract information from the Data Together database.

API Documentation: https://api.archivers.co/docs/

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 Affero 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

Installation and Local Deployment

Generating Documentation

THe API documentation is OpenAPI/Swagger compliant and is generated by the spectacle node module. You will likely want to explore these docs, so you should generate them!

  1. Install spectacle with npm -g install specatacle-docs
  2. To dynamically generate API docs as you work, run spectacle -d open_api.yaml and edit open_api.yaml to see changes
  3. Generate Static docs with spectacle open_api.yaml
  4. Commit. Rinse. Repeat.

Development

Right now modifying & updating code is a huge pain, but this is at least a start.