djangoadmin/djangoadmin-wiki

Fork 0

Files

T

gitadmin 91998056ca 签入版本

2026-09-12 23:12:15 +08:00

11 KiB

Raw Blame History

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

API 接口速查表

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

认证管理（免登录）

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

用户管理

方法	路径	说明	权限
GET	`/api/v1/user/page`	分页查询	`sys:user:page`
GET	`/api/v1/user/detail/<id>`	详情查询	`sys:user:detail`
GET	`/api/v1/user/list`	列表查询	`sys:user:list`
POST	`/api/v1/user/add`	新增用户	`sys:user:add`
PUT	`/api/v1/user/update`	更新用户	`sys:user:update`
DELETE	`/api/v1/user/delete/<id>`	删除用户	`sys:user:delete`
DELETE	`/api/v1/user/batchDelete`	批量删除	`sys:user:batchDelete`
PUT	`/api/v1/user/status`	设置状态	`sys:user:status`
PUT	`/api/v1/user/resetPwd`	重置密码	`sys:user:resetPwd`
POST	`/api/v1/user/import`	导入用户	`sys:user:import`
GET	`/api/v1/user/export`	导出用户	`sys:user:export`

角色管理

方法	路径	说明	权限
GET	`/api/v1/role/page`	分页查询	`sys:role:page`
GET	`/api/v1/role/detail/<id>`	详情查询	`sys:role:detail`
GET	`/api/v1/role/list`	列表查询	`sys:role:list`
POST	`/api/v1/role/add`	新增角色	`sys:role:add`
PUT	`/api/v1/role/update`	更新角色	`sys:role:update`
DELETE	`/api/v1/role/delete/<id>`	删除角色	`sys:role:delete`
DELETE	`/api/v1/role/batchDelete`	批量删除	`sys:role:batchDelete`
PUT	`/api/v1/role/status`	设置状态	`sys:role:status`
GET	`/api/v1/role/roleMenu/<id>`	获取角色菜单	`sys:role:roleMenu`
POST	`/api/v1/role/assignMenu`	分配菜单	`sys:role:assignMenu`

菜单管理

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

部门管理

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

岗位管理

方法	路径	说明	权限
GET	`/api/v1/position/page`	分页查询	`sys:position:page`
GET	`/api/v1/position/detail/<id>`	详情查询	`sys:position:detail`
GET	`/api/v1/position/list`	列表查询	`sys:position:list`
POST	`/api/v1/position/add`	新增岗位	`sys:position:add`
PUT	`/api/v1/position/update`	更新岗位	`sys:position:update`
DELETE	`/api/v1/position/delete/<id>`	删除岗位	`sys:position:delete`
DELETE	`/api/v1/position/batchDelete`	批量删除	`sys:position:batchDelete`
PUT	`/api/v1/position/status`	设置状态	`sys:position:status`

职级管理

方法	路径	说明	权限
GET	`/api/v1/level/page`	分页查询	`sys:level:page`
GET	`/api/v1/level/detail/<id>`	详情查询	`sys:level:detail`
GET	`/api/v1/level/list`	列表查询	`sys:level:list`
POST	`/api/v1/level/add`	新增职级	`sys:level:add`
PUT	`/api/v1/level/update`	更新职级	`sys:level:update`
DELETE	`/api/v1/level/delete/<id>`	删除职级	`sys:level:delete`
DELETE	`/api/v1/level/batchDelete`	批量删除	`sys:level:batchDelete`
PUT	`/api/v1/level/status`	设置状态	`sys:level:status`

文章管理

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

分类管理

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

公告管理

方法	路径	说明	权限
GET	`/api/v1/notice/page`	分页查询	`sys:notice:page`
GET	`/api/v1/notice/detail/<id>`	详情查询	`sys:notice:detail`
POST	`/api/v1/notice/add`	新增公告	`sys:notice:add`
PUT	`/api/v1/notice/update`	更新公告	`sys:notice:update`
DELETE	`/api/v1/notice/delete/<id>`	删除公告	`sys:notice:delete`
DELETE	`/api/v1/notice/batchDelete`	批量删除	`sys:notice:batchDelete`

友链管理

方法	路径	说明	权限
GET	`/api/v1/link/page`	分页查询	`sys:link:page`
GET	`/api/v1/link/detail/<id>`	详情查询	`sys:link:detail`
POST	`/api/v1/link/add`	新增友链	`sys:link:add`
PUT	`/api/v1/link/update`	更新友链	`sys:link:update`
DELETE	`/api/v1/link/delete/<id>`	删除友链	`sys:link:delete`
DELETE	`/api/v1/link/batchDelete`	批量删除	`sys:link:batchDelete`

参数管理

方法	路径	说明	权限
GET	`/api/v1/param/page`	分页查询	`sys:param:page`
GET	`/api/v1/param/detail/<id>`	详情查询	`sys:param:detail`
POST	`/api/v1/param/add`	新增参数	`sys:param:add`
PUT	`/api/v1/param/update`	更新参数	`sys:param:update`
DELETE	`/api/v1/param/delete/<id>`	删除参数	`sys:param:delete`
DELETE	`/api/v1/param/batchDelete`	批量删除	`sys:param:batchDelete`

字典管理

方法	路径	说明	权限
GET	`/api/v1/dict/page`	字典分页查询	`sys:dict:page`
GET	`/api/v1/dict/detail/<id>`	字典详情	`sys:dict:detail`
POST	`/api/v1/dict/add`	新增字典	`sys:dict:add`
PUT	`/api/v1/dict/update`	更新字典	`sys:dict:update`
DELETE	`/api/v1/dict/delete/<id>`	删除字典	`sys:dict:delete`
GET	`/api/v1/dictItem/page`	字典项分页	`sys:dictItem:page`
GET	`/api/v1/dictItem/detail/<id>`	字典项详情	`sys:dictItem:detail`
POST	`/api/v1/dictItem/add`	新增字典项	`sys:dictItem:add`
PUT	`/api/v1/dictItem/update`	更新字典项	`sys:dictItem:update`
DELETE	`/api/v1/dictItem/delete/<id>`	删除字典项	`sys:dictItem:delete`

配置管理

方法	路径	说明	权限
GET	`/api/v1/config/page`	配置分页查询	`sys:config:page`
GET	`/api/v1/config/detail/<id>`	配置详情	`sys:config:detail`
POST	`/api/v1/config/add`	新增配置	`sys:config:add`
PUT	`/api/v1/config/update`	更新配置	`sys:config:update`
DELETE	`/api/v1/config/delete/<id>`	删除配置	`sys:config:delete`
GET	`/api/v1/configItem/page`	配置项分页	`sys:configItem:page`
GET	`/api/v1/configItem/detail/<id>`	配置项详情	`sys:configItem:detail`
POST	`/api/v1/configItem/add`	新增配置项	`sys:configItem:add`
PUT	`/api/v1/configItem/update`	更新配置项	`sys:configItem:update`
DELETE	`/api/v1/configItem/delete/<id>`	删除配置项	`sys:configItem:delete`

定时任务

方法	路径	说明	权限
GET	`/api/v1/job/page`	分页查询	`sys:job:page`
GET	`/api/v1/job/detail/<id>`	详情查询	`sys:job:detail`
POST	`/api/v1/job/add`	新增任务	`sys:job:add`
PUT	`/api/v1/job/update`	更新任务	`sys:job:update`
DELETE	`/api/v1/job/delete/<id>`	删除任务	`sys:job:delete`
PUT	`/api/v1/job/status`	设置状态	`sys:job:status`
POST	`/api/v1/job/run`	立即执行	`sys:job:run`
GET	`/api/v1/jobLog/page`	任务日志分页	`sys:jobLog:page`
DELETE	`/api/v1/jobLog/clean`	清空日志	`sys:jobLog:clean`

文件上传

方法	路径	说明	权限
POST	`/api/v1/upload/uploadFile`	上传文件	`sys:upload:file`

日志管理

方法	路径	说明	权限
GET	`/api/v1/loginLog/page`	登录日志分页	`sys:loginLog:page`
DELETE	`/api/v1/loginLog/clean`	清空登录日志	`sys:loginLog:clean`
GET	`/api/v1/operationLog/page`	操作日志分页	`sys:operationLog:page`
DELETE	`/api/v1/operationLog/clean`	清空操作日志	`sys:operationLog:clean`

代码生成

方法	路径	说明	权限
GET	`/api/v1/generator/page`	数据库表分页	`sys:generator:page`
GET	`/api/v1/generator/detail/<table_name>`	表详情	`sys:generator:detail`
GET	`/api/v1/generator/columns/<table_name>`	表字段信息	`sys:generator:detail`
POST	`/api/v1/generator/generate`	代码生成	`sys:generator:generate`
POST	`/api/v1/generator/batchGenerate`	批量生成	`sys:generator:batchGenerate`

公共接口

方法	路径	说明	权限
GET	`/api/v1/index`	首页数据	需登录

通用请求格式

分页查询参数

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

通用响应格式

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

// 分页响应
{
    "code": 0,
    "msg": "操作成功",
    "data": [...],
    "count": 100,
    "ok": true
}

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

批量删除请求体

[1, 2, 3]

请求体为 ID 数组，Content-Type 为 application/json。

总结

API 接口速查表汇总了系统所有 RESTful 接口，按模块分组列出请求方法、路径、说明和权限标识。接口路径统一以 /api/v1/ 为前缀，权限标识遵循 sys:{模块}:{操作} 命名规范。

11 KiB Raw Blame History