Confluence

使用 Node.js 构建，使用 restify、 swagger 中间件。

搭建开发环境

下载项目：

git clone https://github.com/htcAP/se_server.git

进入工作目录：

cd se_server

安装项目需要的依赖：

npm install

运行项目：

swagger project start

运行测试：

# 数据层测试用例会修改生产环境的数据库，请谨慎操作
swagger project test

查看 API

API 层使用 swagger 中间件构建。代码变动后 node 会执行热更新，但 api 文档本身是静态的，需要手动重启更新。

使用 Swagger UI 查看 API 文档：

http://localhost:10010/apidoc/index.html

在线调试 API：

使用 Swagger 编辑器修改 API：

swagger project edit

提交规范

• 使用新的分支工作，通过 Pull Request 和主分支合并。

• 使用 npm 全家桶，不要上传依赖的框架代码。

npm install <package_name> --save

• 使用 ES 6 语法，保证代码风格统一（let、箭头函数）。