Skip to content

认证管理 ​

接口列表 ​

方法路径说明
POST/auth/login用户登录
POST/auth/logout用户登出
POST/auth/refresh刷新令牌
GET/auth/tokens列出活跃令牌
DELETE/auth/tokens/{token_id}撤销令牌

POST /auth/login ​

用户登录

用户登录获取访问令牌

请求体 ​

登录请求

类型: LoginRequest

字段类型必填说明
passwordstring是密码 示例: "admin"
usernamestring是用户名 示例: "admin"

响应 ​

200 - 登录成功 ​

类型: LoginResponse

字段类型必填说明
access_tokenstring否Access Token 示例: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
expires_ininteger否Access Token 过期时间(秒) 示例: 604800
refresh_tokenstring否Refresh Token 示例: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
token_typestring否Token 类型 示例: "Bearer"

400 - 请求数据错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

401 - 用户名或密码错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

500 - 服务器错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

内容类型 ​

  • 请求: application/json
  • 响应: application/json

POST /auth/logout ​

用户登出

用户登出,撤销当前访问令牌

需要认证

此接口需要 Bearer Token 认证

响应 ​

200 - 登出成功 ​

类型: SuccessResponse

字段类型必填说明
messagestring否成功信息 示例: "操作成功"

401 - 未授权 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

500 - 服务器错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

内容类型 ​

  • 请求: application/json
  • 响应: application/json

POST /auth/refresh ​

刷新令牌

使用刷新令牌获取新的访问令牌

请求体 ​

刷新令牌请求

类型: RefreshTokenRequest

字段类型必填说明
refresh_tokenstring是刷新令牌 示例: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

响应 ​

200 - 刷新成功 ​

类型: RefreshResponse

字段类型必填说明
access_tokenstring否
expires_ininteger否
refresh_tokenstring否
token_typestring否

400 - 请求数据错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

401 - 刷新令牌无效 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

500 - 服务器错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

内容类型 ​

  • 请求: application/json
  • 响应: application/json

GET /auth/tokens ​

列出活跃令牌

获取当前用户的所有活跃令牌列表

需要认证

此接口需要 Bearer Token 认证

查询参数 ​

参数类型必填说明
typestring否令牌类型 可选值: access, refresh
limitinteger否每页数量 默认: 20
offsetinteger否偏移量 默认: 0

响应 ​

200 - 令牌列表 ​

类型: map[string]any

401 - 未授权 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

500 - 服务器错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

内容类型 ​

  • 请求: application/json
  • 响应: application/json

DELETE /auth/tokens/{token_id} ​

撤销令牌

撤销指定的令牌

需要认证

此接口需要 Bearer Token 认证

路径参数 ​

参数类型必填说明
token_idstring是令牌ID

请求体 ​

撤销令牌请求

类型: RevokeTokenRequest

字段类型必填说明
reasonstring否撤销原因 示例: "用户主动登出"

响应 ​

200 - 撤销成功 ​

类型: SuccessResponse

字段类型必填说明
messagestring否成功信息 示例: "操作成功"

400 - 请求数据错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

401 - 未授权 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

500 - 服务器错误 ​

类型: ErrorResponse

字段类型必填说明
detailstring否详细错误信息(可选) 示例: "详细错误信息"
errorstring否错误信息 示例: "操作失败"

内容类型 ​

  • 请求: application/json
  • 响应: application/json