coco/public-people-api repository overview

⁠Public API for People (public-people-api)

Generates JSON representation of a Person in public-friendly format.

People are being migrated to be served from the new Public Concepts API⁠ and as such this API will eventually be deprecated. From July 2018 requests to this service will be redirected via the concepts api then transformed to match the existing contract and returned.

⁠Build & deployment

• Built by Docker Hub: coco/public-people-api⁠
• CI provided by CircleCI: public-people-api⁠

⁠Installation & running locally

1. Run the tests and install the binary:

    dep ensure -vendor-only
    go test ./... -race
    go install
   

   Copy

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

    $GOPATH/bin/public-people-api [--help]  
   

   Copy

Options:

  --app-system-code         System Code of the application (env $APP_SYSTEM_CODE) (default "public-people-api")
  --app-name                Application name (env $APP_NAME) (default "Public People API")
  --log-level               App log level (env $LOG_LEVEL) (default "info")
  --port                    Port to listen on (env $PORT) (default 8080)
  --cache-duration          Duration Get requests should be cached for. e.g. 2h45m would set the max-age value to '7440' seconds (default:30s)
  --requestLoggingEnabled   Whether to log requests (env $REQUEST_LOGGING_ENABLED) (default true)
  --publicConceptsApiURL    Public concepts API endpoint URL. ($CONCEPTS_API) (default: "http://localhost:8080")

        

⁠Test locally

go test -v -race ./...

⁠Endpoints

• Based on the following google doc⁠.
• See the api⁠ for the swagger definitions of the endpoints below.