area area

模块 area:共 2 个接口 —— 2 个被前端调用(在用),0 个未被调用(含 0 个开放/回调/内部)。用下方筛选可只看“在用/未使用”,或在右栏目录按名称过滤。

AreaController 2/2 在用

POST /system/area/get-by-ip 在用管理后台 #
(无摘要) · AreaController
基本信息
控制器com.jxxx.dscp.api.controller.area.AreaController#getAreaByIp
所属模块area area
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表(未解析到业务表:可能为纯校验/转发/缓存/外部接口)
调用链路(控制器方法内未解析到 Service/Mapper 调用,可能为接口声明或简单转发)
方法内调用IPUtils.getArea;AreaUtils.format
环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/system/area/get-by-ip
uathttps://dscp-uat.hn12301.net/manage-api/system/area/get-by-ip
prohttps://dscp-uat.hn12301.net/manage-api/system/area/get-by-ip (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path
位置名称类型必填取值/校验表 / 列说明
queryipString
请求参数 · Body

请求体类型:(未在仓库索引到该 DTO 源码,无法展开字段;可能位于依赖 jar 或为 Map/基础类型)

响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 String (scalar)

标量/Map/外部类型:String

示例
请求示例 (自动生成,仅结构参考)
POST /system/area/get-by-ip?ip=…
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": ""
}
处理逻辑
逻辑摘要查询详情(IPUtils.getArea);调用 format(AreaUtils.format)
内联注释
  • 获得城市
  • 格式化返回
POST /system/area/tree 在用管理后台 #
(无摘要) · AreaController
基本信息
控制器com.jxxx.dscp.api.controller.area.AreaController#getAreaTree
所属模块area area
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表(未解析到业务表:可能为纯校验/转发/缓存/外部接口)
调用链路(控制器方法内未解析到 Service/Mapper 调用,可能为接口声明或简单转发)
方法内调用AreaUtils.getArea;BeanUtils.map
环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/system/area/tree
uathttps://dscp-uat.hn12301.net/manage-api/system/area/tree
prohttps://dscp-uat.hn12301.net/manage-api/system/area/tree (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body

请求体类型:(未在仓库索引到该 DTO 源码,无法展开字段;可能位于依赖 jar 或为 Map/基础类型)

响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 List<AreaResponse> (list)
字段类型必填取值/校验表 / 列说明
[ ]array列表,元素结构见下
idLongid
nameString名称
childrenList<AreaResponse>子节点
children[].…(循环引用,已折叠)
示例
请求示例 (自动生成,仅结构参考)
POST /system/area/tree
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": 1,
      "name": "",
      "children": [
        {}
      ]
    }
  ]
}
处理逻辑
逻辑摘要查询详情(AreaUtils.getArea);入参与返回值经 BeanUtils 做对象/分页映射