coco/relations-api repository overview
Relations API
Relations API is an internally used API for retrieving content collection related content. That is:
- content of CURATED relations
- content of CONTAINS relations for a given content or content collection (content package)
Usage
Install
Download the source code, dependencies and build the binary:
go get github.com/Financial-Times/relations-api
cd $GOPATH/src/github.com/Financial-Times/relations-api
go install
Tests
Start Neo4J:
docker run --publish=7474:7474 --publish=7687:7687 -e NEO4J_AUTH=none -e NEO4J_ACCEPT_LICENSE_AGREEMENT=yes neo4j:3.4.10-enterprise
Execute test:
go test -mod=readonly -race ./...
Running locally
Run the binary (using the help flag to see the available optional arguments):
$GOPATH/bin/relations-api [--help]
Options:
--neo-url="http://localhost:7474/db/data" neo4j endpoint URL ($NEO_URL)
--port="8080" Port to listen on ($PORT)
--cache-duration="30s" Duration Get requests should be cached for. e.g. 2h45m would set the max-a
ge value to '7440' seconds ($CACHE_DURATION)
Endpoints
Application specific endpoints:
- /content/{uuid}/relations
- /contentcollection/{uuid}/relations
Admin specific endpoints:
- /ping
- /build-info
- /__ping
- /__build-info
- /__health
- /__gtg
Examples
For /content/{uuid}/relations endpoint:
GET https://pre-prod-uk-up.ft.com/__relations-api/content/9b6eb364-0275-11e7-b9ac-52b4e2bf8289/relations
{
"curatedRelatedContent": [{
"id": "http://api.ft.com/things/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90",
"apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
}]
"contains": [{
"id": "http://api.ft.com/things/74bd05b4-edca-11e6-1234-ee7d9c5b3b90",
"apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
},
{
"id": "http://api.ft.com/things/74bd05b4-edca-11e6-1313-ee7d9c5b3b90",
"apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
}]
"containedIn": [{
"id": "http://api.ft.com/things/74bd05b4-adsd-1342-abbc-ee7d9c5b3b90",
"apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
}]
}
For /contentcollection/{uuid}/relations endpoint (for content package):
GET https://pre-prod-uk-up.ft.com/__relations-api/content/9b6eb364-0275-11e7-b9ac-52b4e2bf8289/relations
{
"contains": [{
"id": "http://api.ft.com/things/74bd05b4-edca-11e6-1234-ee7d9c5b3b90",
"apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
},
{
"id": "http://api.ft.com/things/74bd05b4-edca-11e6-1313-ee7d9c5b3b90",
"apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
}]
"containedIn": [{
"id": "http://api.ft.com/things/74bd05b4-adsd-1342-abbc-ee7d9c5b3b90",
"apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
}]
}
Tag summary
Content type
Image
Digest
sha256:0638330be…
Size
8.6 MB
Last updated
about 2 months ago
docker pull coco/relations-api