Skip to content

API-Documentation-zh.md

Latest commit

 

History

History
143 lines (95 loc) · 2.54 KB

API-Documentation-zh.md

File metadata and controls

143 lines (95 loc) · 2.54 KB

API 文档

语言版本: English | 中文

概述

本文档提供 API 入口与通用约定。 后台管理接口的详细行为请查看：

基础地址

本地开发：

http://localhost:8080

完整路由前缀：

/{apiPrefix}/...

默认 apiPrefix 为 dudu-admin-api。

路由分组

外部接口

  • /{apiPrefix}/external/ping
  • /{apiPrefix}/external/service/auth/token
  • /{apiPrefix}/external/service/auth/app

内部服务接口

  • /{apiPrefix}/internal/ping
  • /{apiPrefix}/internal/service/auth/token
  • /{apiPrefix}/internal/service/auth/app

内部后台鉴权接口

挂载路径：

  • /{apiPrefix}/internal/admin/auth/...

完整路由与流程说明：

内部后台系统接口

挂载路径：

  • /{apiPrefix}/internal/admin/system/...

主要模块：

  • menu
  • permission
  • role
  • user
  • record

完整路由与数据结构说明：

鉴权方式

应用接口鉴权

受保护接口使用：

Authorization: Bearer <app-token>

取 token 接口：

POST /{apiPrefix}/external/service/auth/token

后台接口鉴权

后台接口使用 CheckAdminAuth。 支持以下 token 来源：

  • Authorization: Bearer <admin-token>
  • Cookie admin-token

操作日志

/{apiPrefix}/internal/admin/system/* 路由会经过 SaveOperationRecord 并记录操作日志。 /{apiPrefix}/internal/admin/auth/* 路由默认不经过 SaveOperationRecord。 敏感请求/响应字段应脱敏或不入日志。

通用响应格式

{
  "code": 0,
  "msg": "ok",
  "trace": {
    "id": "afeade2f5957-tcdtjo-gdmaj",
    "desc": ""
  },
  "data": {}
}

健康检查

外部健康检查：

GET /{apiPrefix}/external/ping

内部健康检查：

GET /{apiPrefix}/internal/ping

错误码与国际化

  • 错误码定义：app/pkg/e/*.go
  • 语言文件：
    • bin/lang/en-US.json
    • bin/lang/zh-CN.json

新增错误码时，需同步更新中英文语言文件。

相关文档