orange-api v1.0.1

Orange-ci API

Orange-ci API 提供了 Orange-ci 的一些构建结果查询接口，接口使用 RESTful 规范以及 GraphQL。

有以下主要特点：

• 未使用公司内的组件，如 L5 等
• 规范使用 Node 生态的包管理机制，一切依赖存放在 package.json 中。使用 tnpm 管理，并启用 package-lock.json
• 规范使用环境变量来控制应用的环境（dev、prod）
• 规范使用环境变量来引入应用的数据库信息（host、ip）
• 发布过程使用 Docker，构建出 Docker 镜像，然后在 k8s 平台上进行发布

主要技术栈：

• Typescript
• Koa
• Bunyan
• MongoDB
• Mysql
• GraphQL

调用文档

参见 http://doc.orange-ci.oa.com/open-api.html

开发相关

运行

# 生产环境启动
$ tnpm run start
# 开发环境启动
$ NODE_ENV=development tnpm run start
# 开发环境启动，并且启动 nodemon 自动监听文件变化重启服务
$ tnpm run dev

测试

# 使用 eslint 检测代码风格变化
$ tnpm run lint

Contributing

This project follows the Contributor Covenant Code of Conduct.

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or ask feature requests.

License

Provided under the terms of the MIT License.