OpenAPI 约定

契约文件：contracts/openapi/rbac-api.yaml

主要标签（Tags）

Tag	说明
Auth	login、refresh、logout、me、change-password、health
SystemUser	用户 CRUD、分配角色
SystemRole	角色 CRUD、分配权限
SystemMenu	菜单树 CRUD
SystemPermission	权限列表

认证接口

方法	路径	鉴权
POST	/api/v1/auth/login	无
POST	/api/v1/auth/refresh	无
POST	/api/v1/auth/logout	需登录
GET	/api/v1/auth/me	需登录
POST	/api/v1/auth/change-password	需登录
GET	/api/v1/health	无

LoginResponse 核心字段

{
  "accessToken": "eyJ...",
  "refreshToken": "eyJ...",
  "user": { "id": 1, "username": "admin", ... },
  "roles": [{ "id": 1, "code": "admin", "name": "管理员" }],
  "permissions": ["system:user:list", "system:role:list", ...],
  "menus": [{ "id": 1, "name": "系统管理", "children": [...] }]
}

在线文档

• Java：springdoc → /swagger-ui.html
• Python：FastAPI → /docs

相关文档

• API 响应规范
• types 包