Skip to content

API 概览 ​

MengStack API 基于 RESTful 设计,所有接口统一前缀 /api/v1。

基础信息 ​

项目值
Base URLhttp://localhost:2222/api/v1
数据格式JSON
认证方式Bearer Token (JWT)
API 文档http://localhost:2222/swagger/index.html

统一响应格式 ​

所有接口返回统一格式:

json
{
  "code": 0,
  "message": "success",
  "data": {},
  "trace_id": "req-abc-123"
}
字段类型说明
codeint状态码,0 表示成功
messagestring状态描述
dataany响应数据
trace_idstring请求追踪 ID

错误码 ​

HTTP 状态码说明
200成功
400请求参数错误
401未认证或 Token 过期
403无权限
404资源不存在
409资源冲突(如邮箱已注册)
500服务器内部错误

认证 ​

需要认证的接口,在请求头中携带:

Authorization: Bearer <access_token>
X-Tenant-ID: <tenant_id>

接口列表 ​

模块端点说明
认证POST /auth/register用户注册,详见认证接口
认证POST /auth/login用户登录,详见认证接口
认证POST /auth/refresh刷新令牌,详见认证接口
认证POST /password修改密码,详见认证接口
认证GET /profile获取当前用户,详见认证接口
系统GET /health健康检查,详见系统接口
系统GET /ping连通性测试,详见系统接口

Swagger UI ​

启动服务后访问 http://localhost:2222/swagger/index.html 查看交互式 API 文档。