mo2设计标准

代码规范

  • 所有变量、函数命名应用camelCase

    • 导出除外(首字母大写)

  • 功能分为多个模块

    • 数据库操作

    • 处理HTTP请求

    • ……

  • 模块划分

合作规范

  1. 在本地开发具有重要进展时合并到远程主分支

  2. 避免同时修改相同文件,在修改某文件时提前告诉对方

合作流程

[提出issue]->[确认解决的人]
[确认解决的人]->[创建对应的分支]
[创建对应的分支]->[解决issue]
[解决issue]->[提交pull request,设置对方为reviewer]
[提交pull request,设置对方为reviewer]->[通过所有自动化测试以及review,合并]
[提交pull request,设置对方为reviewer]->[无法通过测试或review]
[无法通过测试或review]->[解决issue]

设计

后端接口

创建用户

  • 方法:post

  • 参数:body

{
    "userName": "userame",
    "email": "email",
    "password": "password"
}

Important


userName与email唯一,用户可通过任意项登录

用户登录

  • 方法:post

  • 参数:body

{
    "userName": "userame",
    "email": "email",
    "password": "password"
}

用户登出

  • 方法:get

  • 参数:无

Tip


.......未完待续