Public | Automated Build

Last pushed: 2 days ago
Short Description
Neo4j backed things read API
Full Description

Public API for Things (public-things-api)

Provides a public API for Things 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-things-api
  • cd $GOPATH/src/github.com/Financial-Times/public-things-api
  • go test ./...
  • go install
  • $GOPATH/bin/public-things-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/things/143ba45c-2fb3-35bc-b227-a6ed80b5c517 | json_pp
    Or using httpie
  • http GET http://localhost:8080/things/143ba45c-2fb3-35bc-b227-a6ed80b5c517

API definition

Based on the following google doc

Healthchecks

Healthchecks: http://localhost:8080/__health

Go To Go

Go to go: http://localhost:8080/__gtg

Logging

The application uses logrus, the logfile is initialised in main.go.

Logging requires an env app parameter: for all environments 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: http://localhost:8080/__gtg 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

Comments (0)