GET 获取前台导航
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/menu/home |
| 所属业务 | 站点内容 |
| 来源模块/系统 | 导航管理 |
| 认证方式 | Bearer Token(管理员令牌) |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
获取前台导航
请求参数
无请求参数。
成功响应
正在加载示例…失败响应 400:请求参数或业务校验失败
正在加载示例…失败响应 401:未认证或登录已失效
正在加载示例…失败响应 403:无权执行当前操作
正在加载示例…失败响应 404:接口或业务资源不存在
正在加载示例…失败响应 500:服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.menu | [object] | 否 | — | 菜单 |
data.menu[].id | integer(int32) | 否 | — | 菜单ID |
data.menu[].type | string | 否 | — | 菜单类型 system系统 plugin插件 custom自定义 module模块 embedded内嵌 |
data.menu[].name | string | 否 | — | 名称 |
data.menu[].language | object | 否 | — | 语言 |
data.menu[].url | string | 否 | — | 网址 |
data.menu[].second_reminder | integer(int32) | 否 | — | 二次提醒 0否 1是 |
data.menu[].icon | string | 否 | — | 图标 |
data.menu[].nav_id | integer(int32) | 否 | — | 导航ID |
data.menu[].parent_id | integer(int32) | 否 | — | 父ID |
data.menu[].module | [string] | 否 | — | 模块类型 |
data.menu[].res_module | [string] | 否 | — | res模块类型 |
data.menu[].product_id | [integer] | 否 | — | 包含商品 |
data.menu[].is_cross_module | integer(int32) | 否 | — | 是否为跨模块列表 |
data.menu[].select_field | [string] | 否 | — | 选择字段 area=区域 product_name=商品名称 billing_cycle=计费方式 is_auto_renew=自动续费 base_info=基础信息 ip=IP os=OS active_time=开通时间 due_time=到期时间 status=状态 notes=备注 |
data.menu[].child | [object] | 否 | — | 子菜单 |
data.menu[].child[].id | integer(int32) | 否 | — | 菜单ID |
data.menu[].child[].type | string | 否 | — | 菜单类型 system系统 plugin插件 custom自定义 module模块 embedded内嵌 |
data.menu[].child[].name | string | 否 | — | 名称 |
data.menu[].child[].language | object | 否 | — | 语言 |
data.menu[].child[].url | string | 否 | — | 网址 |
data.menu[].child[].second_reminder | integer(int32) | 否 | — | 二次提醒 0否 1是 |
data.menu[].child[].icon | string | 否 | — | 图标 |
data.menu[].child[].nav_id | integer(int32) | 否 | — | 导航ID |
data.menu[].child[].parent_id | integer(int32) | 否 | — | 父ID |
data.menu[].child[].module | [string] | 否 | — | 模块类型 |
data.menu[].child[].res_module | [string] | 否 | — | res模块类型 |
data.menu[].child[].product_id | [integer] | 否 | — | 包含商品 |
data.menu[].child[].is_cross_module | integer(int32) | 否 | — | 是否为跨模块列表 |
data.menu[].child[].select_field | [string] | 否 | — | 选择字段 area=区域 product_name=商品名称 billing_cycle=计费方式 is_auto_renew=自动续费 base_info=基础信息 ip=IP os=OS active_time=开通时间 due_time=到期时间 status=状态 notes=备注 |
data.language | [object] | 否 | — | 语言 |
data.language[].display_name | string | 否 | — | 语言名称 |
data.language[].display_flag | string | 否 | — | 国家代码 |
data.language[].display_img | string | 否 | — | 图片 |
data.language[].display_lang | string | 否 | — | 语言标识 |
data.system_nav | [object] | 否 | — | 系统默认导航 |
data.system_nav[].id | string | integer(int32) | 否 | — | 导航ID |
data.system_nav[].name | string | 否 | — | 名称 |
data.system_nav[].url | string | 否 | — | 网址 |
data.plugin_nav | [object] | 否 | — | 插件默认导航 |
data.plugin_nav[].title | string | 否 | — | 插件标题 |
data.plugin_nav[].nav | [object] | 否 | — | 插件导航 |
data.plugin_nav[].nav[].id | integer(int32) | 否 | — | 导航ID |
data.plugin_nav[].nav[].name | string | 否 | — | 名称 |
data.plugin_nav[].nav[].url | string | 否 | — | 网址 |
data.plugin_nav[].navs | [object] | 否 | — | — |
data.plugin_nav[].navs[].id | integer(int32) | 否 | — | — |
data.plugin_nav[].navs[].name | string | 否 | — | — |
data.plugin_nav[].navs[].url | string | 否 | — | — |
data.module | [object] | 否 | — | 模块 |
data.module[].name | string | 否 | — | 模块名称 |
data.module[].display_name | string | 否 | — | 模块显示名称 |
data.module[].version | string | 否 | — | — |
data.res_module | [object] | 否 | — | 上游模块 |
data.res_module[].name | string | 否 | — | 上游模块名称 |
data.res_module[].display_name | string | 否 | — | 上游模块显示名称 |
失败状态码 400、401、403、404、500 共用以下结构:
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |