This repository has been archived by the owner on Nov 5, 2019. It is now read-only.

datatogether / api Public archive

Notifications You must be signed in to change notification settings
Fork 4
Star 1

Serves the Data Together JSON API

api.archivers.co/docs/

AGPL-3.0 license

1 star 4 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 53 Commits
.circleci		.circleci
Godeps		Godeps
apiutil		apiutil
public		public
sql		sql
vendor		vendor
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
auth.go		auth.go
code_of_conduct.md		code_of_conduct.md
collection_handlers.go		collection_handlers.go
collections_requests.go		collections_requests.go
config.go		config.go
coverage.out		coverage.out
coverage_handlers.go		coverage_handlers.go
docker-compose.yml		docker-compose.yml
handlers.go		handlers.go
main_test.go		main_test.go
middleware.go		middleware.go
open_api.yaml		open_api.yaml
primer_handlers.go		primer_handlers.go
primer_requests.go		primer_requests.go
readme.md		readme.md
repository_handlers.go		repository_handlers.go
server.go		server.go
server_test.go		server_test.go
source_handlers.go		source_handlers.go
source_requests.go		source_requests.go
transports.go		transports.go
uncrawlable_handlers.go		uncrawlable_handlers.go
uncrawlable_requests.go		uncrawlable_requests.go
url_handlers.go		url_handlers.go
url_requests.go		url_requests.go
user_handlers.go		user_handlers.go

Repository files navigation

archivers-api

An Archivers 2.0 joint

archivers-api is a json api for archivers 2.0 proposed services. you can hit it at api.archivers.space. It's written in go.

Documentation is at docs.archivers.space

Running locally

Ok, this is a work-in-progress, but if you have docker & docker-compose installed you should be able to clone this repo & run: docker-compose build && docker-compose up from the project directory, and prove it works by visiting http://localhost:3200/v0/urls from a browser, where you should get a JSON response of urls.

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

Generating Documentation

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