coco/public-concordances-api repository overview

⁠Public API for Concordances (public-concordances-api)

Provides a public API for Concordances stored in a Neo4j graph database

This Go app provides an endpoint for the retrieval of concordance data given one or more parameters. This app directly depends upon a connection to a Neo4j database.

⁠Installation & running locally

Installation assumes that go and dep have been installed and are available on the PATH.

• go get -u github.com/Financial-Times/public-concordances-api
• cd $GOPATH/src/github.com/Financial-Times/public-concordances-api
• dep ensure
• go install
• $GOPATH/bin/public-concordances-api --neo-url={neo4jUrl} --port={port}

Both arguments are optional.
--neo-url defaults to http://localhost:7474/db/data⁠, which is the out of box url for a local neo4j instance.
--port defaults to 8080.

Running the tests

docker run --rm \
--publish=7474:7474 --publish=7687:7687 \
-e NEO4J_ACCEPT_LICENSE_AGREEMENT="yes" \
-e NEO4J_AUTH="none" \
neo4j:3.4.10-enterprise

go test -race ./...	

⁠API Endpoints

Based on the following google doc⁠

- GET /concordances?conceptId={thingUri} - Returns a list of all identifiers for given concept
- GET /concordances?conceptId={thingUri}&conceptId={thingUri}... - Returns a list of all identifiers for each concept provided   
- GET /concordances?authority={identifierUri}&identifierValue{identifierValue} - Returns the apiUrl that matches the corresponding identifier 
- GET /concordances?authority={identifierUri}&idenifierValue={identifierValue}&idenifierValue={identifierValue} - Returns a list of all apiUrl's for the corresponding identifiers

⁠Admin endpoints

- GET /__health
- GET /__build-info
- GET /__gtg 

⁠Error handling

Run book⁠ - Panic guide⁠

• The service expects at least 1 conceptId or (authority + identifierValue pair) parameter and will respond with an Error HTTP status code if these are not provided.
• The service will respond with Error HTTP codes if both a conceptId is presented with an authority parameter or if an identifierValue is presented without the authority parameter.
• The service will never respond with Error HTTP status codes if none of the conceptId's or identifierValues are present in concordance, instead it will return an empty array of Concepts or Identifiers.