Home

Welcome to the chatroom-enterprise wiki!

Only the code is publicly available. Unauthorized copying, reproduction, or borrowing is prohibited.

This codebase is not open source. Please carefully review the open source definition.

only Chinese

欢迎！

此文档只适用于后端

安装 & 使用

仅代码公开可用。未经授权，禁止复制、转载或借鉴

此代码库并非开源。请仔细阅读开源定义

前提条件：

• npm & pnpm & 可访问网络

• 下载此代码库

• 进入该文件夹：pnpm i

• 编辑 .env 文件 OR 编辑环境变量

• pnpm dev

• 按照代码指示

历史版本

• 0.1.0
• 0.1.2

API

目前仅适用于0.1.3

除特殊说明所有提交的值应该是JSON格式，GET请求除外

检查健康

• 端点：GET /healthy
• 返回：{status: "healthy"}

注册

• 端点：POST /users/register
• 参数：
  • 邮箱 (email)
  • 密码 (password)
• 返回：status user token

登录

• 端点：POST /users/login
• 参数：
  • 邮箱 (email)
  • 密码 (password)
• 返回：status token

发送验证链接

• 端点：POST /users/email/create
• 需要将登录token放到头部中
• 返回：status

验证邮箱

• 端点：GET /users/email/verify
• 参数：token
• 返回：status

状态码

目前仅适用于0.1.3

这些非常的简单，就不多说了。

export const APP_CODES = {
  // 系统健康
  HEALTHY: "HEALTHY",
  // 用户创建
  USER_CREATE: "USER_CREATE",
  // 非JSON格式提交的数据
  NOT_JSON: "NOT_JSON",
  // 缺少必要参数
  MISSING_ARGUMENTS: "MISSING_ARGUMENTS",
  // 邮箱格式错误
  EMAIL_FORMAT: "EMAIL_FORMAT",
  // 邮箱已被占用
  EMAIL_EXISTS: "EMAIL_EXISTS",
  // 创建用户时出现问题
  USER_ERROR: "USER_ERROR",
  // 验证失败
  AUTH_FAILED: "AUTH_FAILED",
  // 验证成功
  AUTH_SUCCESS: "AUTH_SUCCESS",
  // 发送邮件成功
  SEND_EMAIL_SUCCESS: "SEND_EMAIL_SUCCESS",
  // 发送邮件失败
  SEND_EMAIL_FAILED: "SEND_EMAIL_FAILED",
  // 没有对应的响应头
  NO_AUTHORIZATION: "NO_AUTHORIZATION",
  // TOKEN已过期
  TOKEN_EXPIRED: "TOKEN_EXPIRED",
  // 无此用户
  NO_EXISTS_USER: "NO_EXISTS_USER",
  // 用户已被验证（邮箱）
  USER_VERIFIED: "USER_VERIFIED",
  // 用户验证成功（邮箱）
  USER_VERIFY: "USER_VERIFY",
  // 出现未知错误
  ERROR: "ERROR",

} as const