coco/public-organisations-api

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

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

组织数据正迁移至新的https://github.com/Financial-Times/public-concepts-api%EF%BC%8C%E5%9B%A0%E6%AD%A4%E6%9C%ACAPI%E6%9C%80%E7%BB%88%E5%B0%86%E8%A2%AB%E5%BC%83%E7%94%A8%E3%80%82%E8%87%AA2018%E5%B9%B47%E6%9C%88%E8%B5%B7%EF%BC%8C%E5%AF%B9%E6%9C%AC%E6%9C%8D%E5%8A%A1%E7%9A%84%E8%AF%B7%E6%B1%82%E5%B0%86%E9%80%9A%E8%BF%87%E6%A6%82%E5%BF%B5API%E9%87%8D%E5%AE%9A%E5%90%91%EF%BC%8C%E7%84%B6%E5%90%8E%E8%BD%AC%E6%8D%A2%E4%BB%A5%E5%8C%B9%E9%85%8D%E7%8E%B0%E6%9C%89%E5%8D%8F%E8%AE%AE%E5%B9%B6%E8%BF%94%E5%9B%9E%E3%80%82

构建与部署

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

• 构建与部署

安装

bash
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定义

• 基于https://docs.google.com/document/d/1SC4Uskl-VD78y0lg5H2Gq56VCmM4OFHofZM-OvpsOFo/edit#heading=h.qjo76xuvpj83
• 端点定义参见api Swagger文件

健康检查

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

日志

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