Donny-Hikari / csu-ems-api

APIs for the EMS of CSU, based on Node.js.

CSU-EMS-API

中南大学教务管理系统API，基于Node.js
尚未完成，不管是代码还是这篇文档

TODO

(Section WIP)

• 完成新成绩Email提醒
• ...

APIs

(Section WIP)

获取所有有效成绩和挂科列表

• 路径: /grades/

• 方法: GET

• 必要参数:

  {
    "id": "用户名，一般是学号",
    "pwd": "密码"
  }

• 成功返回:

  {
    "name": "该学生的名字",
    "id": "用户名",
    "grades": {
      // 所有有成绩的科目与相应成绩
      "课程名称": "分数",
      // ...
    },
    "subject-count": "有成绩科目的数量",
    "failed": {
      // 所有挂科的科目与相应成绩
      "课程名称": "分数",
      // ...
    },
    "failed-count": "挂科科目的数量"
  }

• 失败返回:

  {
    "error": "错误原因"
  }

Setup

(Section WIP)

快速部署

$ git clone https://github.com/Equim-chan/csu-ems-api.git
$ cd csu-ems-api
$ npm install
$ npm start

默认会部署在2333端口上，如要修改端口，请使用参数-p [value]

获取帮助

$ node app.js -h

实际部署时请自行调用pm2或forever等deamon

Dependencies

• 详见package.json

Lisence

• 本项目使用GPL-3.0授权。

Initiators