photo-tron

README

Draft Annotations API

Introduction

Draft Annotations API is a microservice that provides access to draft annotations for content stored in PAC. Currently, the service is a simple proxy to UPP Public Annotations API.

Installation

Download the source code, dependencies and test dependencies:

go get -u github.com/kardianos/govendor
mkdir $GOPATH/src/github.com/Financial-Times/photo-tron
cd $GOPATH/src/github.com/Financial-Times
git clone https://github.com/Financial-Times/photo-tron.git
cd photo-tron && govendor sync
go build .

Running locally

1. Run the tests and install the binary:

govendor sync
govendor test -v -race +local
go install

1. Run the binary (using the help flag to see the available optional arguments):

$GOPATH/bin/photo-tron [--help]

Options:
  --app-system-code="photo-tron"                                System Code of the application ($APP_SYSTEM_CODE)
  --app-name="photo-tron"                                       Application name ($APP_NAME)
  --port="8080"                                                            Port to listen on ($APP_PORT)
  --annotations-endpoint="http://test.api.ft.com/content/%v/annotations"   Endpoint to get annotations from UPP ($ANNOTATIONS_ENDPOINT)
  --upp-api-key=""                                                         API key to access UPP ($UPP_APIKEY)
  --api-yml="./api.yml"                                                    Location of the API Swagger YML file. ($API_YML)

1. Test:

   1. Either using curl:

       curl http://localhost:8080/draft/content/b7b871f6-8a89-11e4-8e24-00144feabdc0/annotations | json_pp
      

   2. Or using httpie:

       http GET http://localhost:8080/draft/content/b7b871f6-8a89-11e4-8e24-00144feabdc0/annotations
      

Build and deployment

• Built by Docker Hub on merge to master: coco/photo-tron
• CI provided by CircleCI: photo-tron

Service endpoints

For a full description of API endpoints for the service, please see the Open API specification.

GET

Using curl:

curl http://localhost:8080/draft/content/b7b871f6-8a89-11e4-8e24-00144feabdc0/annotations | jq

Or using httpie:

http GET http://localhost:8080/draft/content/b7b871f6-8a89-11e4-8e24-00144feabdc0/annotations

Currently, this endpoint is a proxy to the annotations available in UPP, so it returns a payload consistent to the UPP Public Annotations API.

Healthchecks

Admin endpoints are:

/__gtg /__health /__build-info

At the moment the /__health and /__gtg check the availability of the UPP Public Annotations API.

Logging

• The application uses logrus; the log file 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, logs are 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 and /__gtg endpoints are not logged as they are called every second from varnish/vulcand and this information is not needed in logs/splunk.