Public | Automated Build

Last pushed: 3 months ago
Short Description
Provides a public API for Organisation stored in a Neo4J graph database.
Full Description

Public API for Organisation (public-organisation-api)

Provides a public API for Organisation stored in a Neo4J graph database

Build & deployment etc:

NB You will need to tag a commit in order to build, since the UI asks for a tag to build / deploy

Installation & running locally

  • go get -u github.com/Financial-Times/public-organisation-api
  • cd $GOPATH/src/github.com/Financial-Times/public-organisation-api

  • go get github.com/kardianos/govendor

  • govendor sync

  • go test ./...

  • go install
  • $GOPATH/bin/public-organisation-api --neo-url={neo4jUrl} --port={port} --log-level={DEBUG|INFO|WARN|ERROR} --cache-duration{e.g. 22h10m3s}
    Optional arguments are:
    --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.
    --cache-duration defaults to 1 hour.
  • curl http://localhost:8080/organisation/143ba45c-2fb3-35bc-b227-a6ed80b5c517 | json_pp
    Or using httpie
  • http GET http://localhost:8080/organisation/143ba45c-2fb3-35bc-b227-a6ed80b5c517

API definition

Based on the following google doc

Healthchecks

Healthchecks: http://localhost:8080/__health

Logging

the application uses logrus, the logfile is initilaised in main.go.
logging requires an env app parameter, for all enviromets other than local logs are written to file
when running locally logging is written to console (if you want to log locally to file you need to pass in an env parameter that is != local)
NOTE: build-info end point is not logged as it is called every second from varnish and this information is not needed in logs/splunk

Docker Pull Command
Owner
coco