公共组织API（public-organisation-api）

为存储在Neo4J图数据库中的组织提供公共API

组织数据正迁移至新的公共概念API，因此本API最终将被弃用。自2018年7月起，对本服务的请求将通过概念API重定向，然后转换以匹配现有协议并返回。

构建与部署

注意：需创建标记版本（tagged release）方可构建

• 构建与部署

安装

go get -u github.com/Financial-Times/public-organisation-api
cd $GOPATH/src/github.com/Financial-Times/public-organisation-api
dep ensure -v -vendor-only
go test ./...
go install

本地运行

Usage: public-organisations-api [OPTIONS]

A public RESTful API for accessing organisations in Neo4j

Options:
      --app-system-code        应用系统代码（环境变量 $APP_SYSTEM_CODE）（默认值 "public-organisation-api"）
      --port                   监听端口（环境变量 $APP_PORT）（默认值 "8080"）
      --log-level              日志级别（环境变量 $LOG_LEVEL）（默认值 "debug"）
      --env                    运行环境（默认值 "local"）
      --cache-duration         Get请求缓存持续时间，例如2h45m会将max-age设为7440秒（环境变量 $CACHE_DURATION）（默认值 "30s"）
      --publicConceptsApiURL   公共概念API端点URL（环境变量 $CONCEPTS_API）（默认值 "http://localhost:8081"）

API定义

• 基于Google文档
• 端点定义参见api Swagger文件

健康检查

健康检查：http://localhost:8080/__health

日志

应用使用logrus，日志文件在main.go中初始化。除本地环境外，其他环境日志写入文件；本地运行时日志输出到控制台（若需本地日志写入文件，需传入非"local"的env参数）。注意：build-info端点不记录日志，因其每秒被varnish调用，无需在日志/Splunk中记录。