djangoadmin-wiki/DjangoAdmin_Django_AntdVue/zh/volume4/api-cheatsheet.md

:::tip 本章概要 API 接口速查表，按模块分组列出所有 RESTful 接口的请求方法、路径、说明和权限标识。 :::

API 接口速查表

本章汇总项目所有 API 接口，按模块分类整理。所有接口统一挂在根路径下，前端通过 /api 前缀代理访问，需携带 Authorization: Bearer <token> 请求头（认证相关接口除外）。

认证管理（免登录）

方法	路径	说明	权限
GET	/captcha	获取图形验证码	无需登录
POST	/login	用户登录	无需登录

系统主页

方法	路径	说明	权限
GET	/index/getMenus	获取用户菜单	需登录
GET	/index/getUser	获取用户信息	需登录
GET	/index/getRouters	获取路由数据	需登录

文件上传

方法	路径	说明	权限
POST	/upload/uploadFile	上传文件	需登录

用户管理

方法	路径	说明	权限
GET	/user/page	分页查询	sys:user:page
GET	/user/detail/{id}	详情查询	sys:user:detail
GET	/user/list	列表查询	需登录
POST	/user/add	新增用户	sys:user:add
PUT	/user/update	更新用户	sys:user:update
DELETE	/user/delete/{id}	删除用户	sys:user:delete
PUT	/user/status	设置状态	sys:user:status
PUT	/user/resetPwd	重置密码	sys:user:resetPwd

角色管理

方法	路径	说明	权限
GET	/role/page	分页查询	sys:role:page
GET	/role/detail/{id}	详情查询	sys:role:detail
GET	/role/list	列表查询	需登录
POST	/role/add	新增角色	sys:role:add
PUT	/role/update	更新角色	sys:role:update
DELETE	/role/delete/{id}	删除角色	sys:role:delete
PUT	/role/status	设置状态	sys:role:status

角色菜单权限

方法	路径	说明	权限
GET	/role/menu/index/{id}	获取角色菜单	sys:role:roleMenu
POST	/role/menu/save	分配菜单	sys:role:assignMenu

菜单管理

方法	路径	说明	权限
GET	/menu/list	菜单列表	sys:menu:list
GET	/menu/detail/{id}	详情查询	sys:menu:detail
POST	/menu/add	新增菜单	sys:menu:add
PUT	/menu/update	更新菜单	sys:menu:update
DELETE	/menu/delete/{id}	删除菜单	sys:menu:delete

部门管理

方法	路径	说明	权限
GET	/dept/list	部门列表	sys:dept:list
GET	/dept/detail/{id}	详情查询	sys:dept:detail
POST	/dept/add	新增部门	sys:dept:add
PUT	/dept/update	更新部门	sys:dept:update
DELETE	/dept/delete/{id}	删除部门	sys:dept:delete

岗位管理

方法	路径	说明	权限
GET	/position/page	分页查询	sys:position:page
GET	/position/detail/{id}	详情查询	sys:position:detail
GET	/position/list	列表查询	需登录
POST	/position/add	新增岗位	sys:position:add
PUT	/position/update	更新岗位	sys:position:update
DELETE	/position/delete/{id}	删除岗位	sys:position:delete
PUT	/position/status	设置状态	sys:position:status

职级管理

方法	路径	说明	权限
GET	/level/page	分页查询	sys:level:page
GET	/level/detail/{id}	详情查询	sys:level:detail
GET	/level/list	列表查询	需登录
POST	/level/add	新增职级	sys:level:add
PUT	/level/update	更新职级	sys:level:update
DELETE	/level/delete/{id}	删除职级	sys:level:delete
PUT	/level/status	设置状态	sys:level:status

城市管理

方法	路径	说明	权限
GET	/city/list	城市列表	sys:city:list
GET	/city/detail/{id}	详情查询	sys:city:detail
POST	/city/add	新增城市	sys:city:add
PUT	/city/update	更新城市	sys:city:update
DELETE	/city/delete/{id}	删除城市	sys:city:delete

文章管理

方法	路径	说明	权限
GET	/article/page	分页查询	sys:article:page
GET	/article/detail/{id}	详情查询	sys:article:detail
POST	/article/add	新增文章	sys:article:add
PUT	/article/update	更新文章	sys:article:update
DELETE	/article/delete/{id}	删除文章	sys:article:delete
PUT	/article/status	设置状态	sys:article:status

分类管理

方法	路径	说明	权限
GET	/category/list	分类列表	sys:category:list
GET	/category/detail/{id}	详情查询	sys:category:detail
POST	/category/add	新增分类	sys:category:add
PUT	/category/update	更新分类	sys:category:update
DELETE	/category/delete/{id}	删除分类	sys:category:delete

公告管理

方法	路径	说明	权限
GET	/notice/page	分页查询	sys:notice:page
GET	/notice/detail/{id}	详情查询	sys:notice:detail
POST	/notice/add	新增公告	sys:notice:add
PUT	/notice/update	更新公告	sys:notice:update
DELETE	/notice/delete/{id}	删除公告	sys:notice:delete

友链管理

方法	路径	说明	权限
GET	/link/page	分页查询	sys:link:page
GET	/link/detail/{id}	详情查询	sys:link:detail
POST	/link/add	新增友链	sys:link:add
PUT	/link/update	更新友链	sys:link:update
DELETE	/link/delete/{id}	删除友链	sys:link:delete
PUT	/link/status	设置状态	sys:link:status

参数管理

方法	路径	说明	权限
GET	/param/page	分页查询	sys:param:page
GET	/param/detail/{id}	详情查询	sys:param:detail
POST	/param/add	新增参数	sys:param:add
PUT	/param/update	更新参数	sys:param:update
DELETE	/param/delete/{id}	删除参数	sys:param:delete

字典管理

方法	路径	说明	权限
GET	/dict/page	字典分页查询	sys:dict:page
GET	/dict/detail/{id}	字典详情	sys:dict:detail
POST	/dict/add	新增字典	sys:dict:add
PUT	/dict/update	更新字典	sys:dict:update
DELETE	/dict/delete/{id}	删除字典	sys:dict:delete

字典项管理

方法	路径	说明	权限
GET	/dict/item/page	字典项分页	sys:dictItem:page
GET	/dict/item/detail/{id}	字典项详情	sys:dictItem:detail
GET	/dict/item/getDictItemList/{code}	按编码获取字典项	需登录
POST	/dict/item/add	新增字典项	sys:dictItem:add
PUT	/dict/item/update	更新字典项	sys:dictItem:update
DELETE	/dict/item/delete/{id}	删除字典项	sys:dictItem:delete

配置管理

方法	路径	说明	权限
GET	/config/page	配置分页查询	sys:config:page
GET	/config/detail/{id}	配置详情	sys:config:detail
POST	/config/add	新增配置	sys:config:add
PUT	/config/update	更新配置	sys:config:update
DELETE	/config/delete/{id}	删除配置	sys:config:delete

配置项管理

方法	路径	说明	权限
GET	/config/item/page	配置项分页	sys:configItem:page
GET	/config/item/detail/{id}	配置项详情	sys:configItem:detail
POST	/config/item/add	新增配置项	sys:configItem:add
PUT	/config/item/update	更新配置项	sys:configItem:update
DELETE	/config/item/delete/{id}	删除配置项	sys:configItem:delete
PUT	/config/item/status	设置状态	sys:configItem:status

网站配置

方法	路径	说明	权限
GET	/config/web/detail	获取网站配置	需登录
PUT	/config/web/update	更新网站配置	sys:configWeb:update

文件模板

方法	路径	说明	权限
GET	/file/template/page	分页查询	sys:fileTemplate:page
GET	/file/template/detail/{id}	详情查询	sys:fileTemplate:detail
POST	/file/template/add	新增模板	sys:fileTemplate:add
PUT	/file/template/update	更新模板	sys:fileTemplate:update
DELETE	/file/template/delete/{id}	删除模板	sys:fileTemplate:delete

定时任务

方法	路径	说明	权限
GET	/job/page	分页查询	sys:job:page
GET	/job/detail/{id}	详情查询	sys:job:detail
POST	/job/add	新增任务	sys:job:add
PUT	/job/update	更新任务	sys:job:update
DELETE	/job/delete/{id}	删除任务	sys:job:delete
PUT	/job/status	设置状态	sys:job:status

任务日志

方法	路径	说明	权限
GET	/job/log/page	任务日志分页	sys:jobLog:page

登录日志

方法	路径	说明	权限
GET	/login/log/page	登录日志分页	sys:loginLog:page

操作日志

方法	路径	说明	权限
GET	/oper/log/page	操作日志分页	sys:operationLog:page

案例管理（示例模块）

方法	路径	说明	权限
GET	/example/page	分页查询	sys:example:page
GET	/example/detail/{id}	详情查询	sys:example:detail
GET	/example/list	列表查询	需登录
GET	/example/data	下拉数据	需登录
POST	/example/add	新增案例	sys:example:add
PUT	/example/update	更新案例	sys:example:update
DELETE	/example/delete/{id}	删除案例	sys:example:delete
PUT	/example/status	设置状态	sys:example:status

代码生成器

方法	路径	说明	权限
GET	/generator/page	数据库表分页	sys:generator:page
GET	/generator/detail/{table_name}	表详情	sys:generator:detail
POST	/generator/generate	代码生成	sys:generator:generate

通用请求格式

分页查询参数

参数	类型	默认值	说明
pageNo	int	1	页码
pageSize	int	10	每页条数
其他字段	-	-	按模块定义的筛选字段传递

通用响应格式

// 成功
{
    "code": 0,
    "msg": "操作成功",
    "data": {},
    "ok": true
}

// 分页响应
{
    "code": 0,
    "msg": "操作成功",
    "data": {
        "records": [],
        "total": 100,
        "size": 10,
        "current": 1,
        "pages": 10
    },
    "ok": true
}

// 失败
{
    "code": 1,
    "msg": "错误信息",
    "data": null,
    "ok": false
}

批量删除请求

批量删除通过 URL 参数传递逗号分隔的 ID：

DELETE /example/delete/1,2,3

总结

API 接口速查表汇总了系统所有 RESTful 接口，按模块分组列出请求方法、路径、说明和权限标识。接口路径直接挂在根路径下，前端通过 /api 前缀代理访问。权限标识遵循 sys:{模块}:{操作} 命名规范。