地区 region

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

RegionController 1/7 在用

POST /region/addRegion 未使用管理后台 #
地区信息-新增 · RegionController
基本信息
控制器com.jxxx.dscp.api.controller.region.RegionController#addRegion
所属模块地区 region
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表region
ControllerRegionController#addRegion
转换BeanUtils.map → Region ⇒ 表 region
ServiceRegionService#add (RegionServiceImpl)
MapperRegionMapper#insert ⇒ 表 region

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/region/addRegion
uathttps://dscp-uat.hn12301.net/manage-api/region/addRegion
prohttps://dscp-uat.hn12301.net/manage-api/region/addRegion (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

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

请求参数 · Body RegionAddRequest
字段类型必填取值/校验表 / 列说明
nameString必填region.name地名
parentIdLongregion.parent_id父Id
shortNameStringregion.short_name简称
levelTypeInteger必填region.level_type级别
cityCodeStringregion.city_code城市编码
zipCodeStringregion.zip_code邮政编码
mergerNameStringregion.merger_name合并名称
lngBigDecimalregion.lng经度
latBigDecimalregion.lat纬度
pinYinStringregion.pin_yin拼音
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 RegionResponse (object)
字段类型必填取值/校验表 / 列说明
idLongregion.id主键
nameStringregion.name地名
parentIdLongregion.parent_id父Id
shortNameStringregion.short_name简称
levelTypeIntegerregion.level_type级别
cityCodeStringregion.city_code城市编码
zipCodeStringregion.zip_code邮政编码
mergerNameStringregion.merger_name合并名称
lngBigDecimalregion.lng经度
latBigDecimalregion.lat纬度
pinYinStringregion.pin_yin拼音
示例
请求示例 (自动生成,仅结构参考)
POST /region/addRegion
{
  "body": {
    "name": "",
    "parentId": 1,
    "shortName": "",
    "levelType": 0,
    "cityCode": "",
    "zipCode": "",
    "mergerName": "",
    "lng": 0,
    "lat": 0,
    "pinYin": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "id": 1,
    "name": "",
    "parentId": 1,
    "shortName": "",
    "levelType": 0,
    "cityCode": "",
    "zipCode": "",
    "mergerName": "",
    "lng": 0,
    "lat": 0,
    "pinYin": ""
  }
}
处理逻辑
操作日志region / 新增地区
逻辑摘要新增(regionService.add);入参与返回值经 BeanUtils 做对象/分页映射
前端调用方

源码扫描未发现 7 个前端对该接口的调用(可能为开放回调/内部/未上线/管理端动态调用)

POST /region/deleteRegion 未使用管理后台 #
地区信息-删除 · RegionController
基本信息
控制器com.jxxx.dscp.api.controller.region.RegionController#deleteRegion
所属模块地区 region
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表region
ControllerRegionController#deleteRegion
ServiceRegionService#delete (RegionServiceImpl)
MapperRegionMapper#deleteById ⇒ 表 region

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/region/deleteRegion
uathttps://dscp-uat.hn12301.net/manage-api/region/deleteRegion
prohttps://dscp-uat.hn12301.net/manage-api/region/deleteRegion (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

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

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填region.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /region/deleteRegion
{
  "body": {
    "id": 1
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志region / 删除地区
逻辑摘要删除(regionService.delete)
前端调用方

源码扫描未发现 7 个前端对该接口的调用(可能为开放回调/内部/未上线/管理端动态调用)

POST /region/getRegion 未使用管理后台 #
地区信息-详情 · RegionController
基本信息
控制器com.jxxx.dscp.api.controller.region.RegionController#getRegion
所属模块地区 region
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表region
ControllerRegionController#getRegion
ServiceRegionService#get (RegionServiceImpl)
MapperRegionMapper#selectById ⇒ 表 region

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/region/getRegion
uathttps://dscp-uat.hn12301.net/manage-api/region/getRegion
prohttps://dscp-uat.hn12301.net/manage-api/region/getRegion (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

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

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填region.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 RegionResponse (object)
字段类型必填取值/校验表 / 列说明
idLongregion.id主键
nameStringregion.name地名
parentIdLongregion.parent_id父Id
shortNameStringregion.short_name简称
levelTypeIntegerregion.level_type级别
cityCodeStringregion.city_code城市编码
zipCodeStringregion.zip_code邮政编码
mergerNameStringregion.merger_name合并名称
lngBigDecimalregion.lng经度
latBigDecimalregion.lat纬度
pinYinStringregion.pin_yin拼音
示例
请求示例 (自动生成,仅结构参考)
POST /region/getRegion
{
  "body": {
    "id": 1
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "id": 1,
    "name": "",
    "parentId": 1,
    "shortName": "",
    "levelType": 0,
    "cityCode": "",
    "zipCode": "",
    "mergerName": "",
    "lng": 0,
    "lat": 0,
    "pinYin": ""
  }
}
处理逻辑
逻辑摘要查询详情(regionService.get);入参与返回值经 BeanUtils 做对象/分页映射
前端调用方

源码扫描未发现 7 个前端对该接口的调用(可能为开放回调/内部/未上线/管理端动态调用)

POST /region/queryRegionList 在用开放/回调 #
地区信息-列表查询 · RegionController
基本信息
控制器com.jxxx.dscp.api.controller.region.RegionController#queryRegionList
所属模块地区 region
暴露渠道开放/回调 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表(未解析到业务表:可能为纯校验/转发/缓存/外部接口)
ControllerRegionController#queryRegionList
转换BeanUtils.map → RegionQuery
其它依赖(权限 / 会话 / 缓存 / 校验等,不直接读写业务表)· 1
RegionListCache.get

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/open-api/region/queryRegionList
uathttps://dscp-uat.hn12301.net/open-api/region/queryRegionList
prohttps://dscp-uat.hn12301.net/open-api/region/queryRegionList (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

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

请求参数 · Body RegionListRequest
字段类型必填取值/校验表 / 列说明
nameString可选(@MvcOptional)地名
parentIdLong可选(@MvcOptional)父Id
shortNameString可选(@MvcOptional)简称
levelTypeInteger可选(@MvcOptional)级别
cityCodeString可选(@MvcOptional)城市编码
zipCodeString可选(@MvcOptional)邮政编码
mergerNameString可选(@MvcOptional)合并名称
lngBigDecimal可选(@MvcOptional)经度
latBigDecimal可选(@MvcOptional)纬度
pinYinString可选(@MvcOptional)拼音
idListList<Long>可选(@MvcOptional)id列表
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 List<RegionResponse> (list)
字段类型必填取值/校验表 / 列说明
[ ]array列表,元素结构见下
idLong主键
nameString地名
parentIdLong父Id
shortNameString简称
levelTypeInteger级别
cityCodeString城市编码
zipCodeString邮政编码
mergerNameString合并名称
lngBigDecimal经度
latBigDecimal纬度
pinYinString拼音
示例
请求示例 (自动生成,仅结构参考)
POST /region/queryRegionList
{
  "body": {
    "name": "",
    "parentId": 1,
    "shortName": "",
    "levelType": 0,
    "cityCode": "",
    "zipCode": "",
    "mergerName": "",
    "lng": 0,
    "lat": 0,
    "pinYin": "",
    "idList": "",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": 1,
      "name": "",
      "parentId": 1,
      "shortName": "",
      "levelType": 0,
      "cityCode": "",
      "zipCode": "",
      "mergerName": "",
      "lng": 0,
      "lat": 0,
      "pinYin": ""
    }
  ]
}
处理逻辑
逻辑摘要见下方调用链;入参与返回值经 BeanUtils 做对象/分页映射
POST /region/queryRegionPage 未使用管理后台 #
地区信息-分页查询 · RegionController
基本信息
控制器com.jxxx.dscp.api.controller.region.RegionController#queryRegionPage
所属模块地区 region
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表region
ControllerRegionController#queryRegionPage
转换BeanUtils.map → RegionQuery
ServiceRegionService#queryPage (RegionServiceImpl)
MapperRegionMapper#selectPage ⇒ 表 region

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/region/queryRegionPage
uathttps://dscp-uat.hn12301.net/manage-api/region/queryRegionPage
prohttps://dscp-uat.hn12301.net/manage-api/region/queryRegionPage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

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

请求参数 · Body RegionPageRequest
字段类型必填取值/校验表 / 列说明
pageNumInteger页码(继承自框架分页基类 AbstractPageRequest)
pageSizeInteger每页条数(继承自框架分页基类 AbstractPageRequest)
nameString可选(@MvcOptional)region.name地名
parentIdLong可选(@MvcOptional)region.parent_id父Id
shortNameString可选(@MvcOptional)region.short_name简称
levelTypeInteger可选(@MvcOptional)region.level_type级别
cityCodeString可选(@MvcOptional)region.city_code城市编码
zipCodeString可选(@MvcOptional)region.zip_code邮政编码
mergerNameString可选(@MvcOptional)region.merger_name合并名称
lngBigDecimal可选(@MvcOptional)region.lng经度
latBigDecimal可选(@MvcOptional)region.lat纬度
pinYinString可选(@MvcOptional)region.pin_yin拼音
idListList<Long>可选(@MvcOptional)id列表
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 PageInfo<RegionResponse> (page)
字段类型必填取值/校验表 / 列说明
list / recordsarray分页列表,元素结构见下
totallong总条数(PageInfo)
idLongregion.id主键
nameStringregion.name地名
parentIdLongregion.parent_id父Id
shortNameStringregion.short_name简称
levelTypeIntegerregion.level_type级别
cityCodeStringregion.city_code城市编码
zipCodeStringregion.zip_code邮政编码
mergerNameStringregion.merger_name合并名称
lngBigDecimalregion.lng经度
latBigDecimalregion.lat纬度
pinYinStringregion.pin_yin拼音
示例
请求示例 (自动生成,仅结构参考)
POST /region/queryRegionPage
{
  "body": {
    "pageNum": 0,
    "pageSize": 0,
    "name": "",
    "parentId": 1,
    "shortName": "",
    "levelType": 0,
    "cityCode": "",
    "zipCode": "",
    "mergerName": "",
    "lng": 0,
    "lat": 0,
    "pinYin": "",
    "idList": "",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "records": [
      {
        "id": 1,
        "name": "",
        "parentId": 1,
        "shortName": "",
        "levelType": 0,
        "cityCode": "",
        "zipCode": "",
        "mergerName": "",
        "lng": 0,
        "lat": 0,
        "pinYin": ""
      }
    ],
    "total": 0
  }
}
处理逻辑
逻辑摘要分页查询(regionService.queryPage);入参与返回值经 BeanUtils 做对象/分页映射
前端调用方

源码扫描未发现 7 个前端对该接口的调用(可能为开放回调/内部/未上线/管理端动态调用)

POST /region/queryRegionTree 未使用管理后台 #
地区信息-树查询 · RegionController
基本信息
控制器com.jxxx.dscp.api.controller.region.RegionController#queryRegionTree
所属模块地区 region
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表(未解析到业务表:可能为纯校验/转发/缓存/外部接口)
ControllerRegionController#queryRegionTree
其它依赖(权限 / 会话 / 缓存 / 校验等,不直接读写业务表)· 1
RegionTreeCache.get

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/region/queryRegionTree
uathttps://dscp-uat.hn12301.net/manage-api/region/queryRegionTree
prohttps://dscp-uat.hn12301.net/manage-api/region/queryRegionTree (仓库 .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<RegionTreeResponse> (list)
字段类型必填取值/校验表 / 列说明
[ ]array列表,元素结构见下
idLong主键
nameString地名
parentIdLong父Id
shortNameString简称
levelTypeInteger级别
cityCodeString城市编码
zipCodeString邮政编码
mergerNameString合并名称
lngBigDecimal经度
latBigDecimal纬度
pinYinString拼音
childrenList<RegionTreeResponse>子级
children[].…(循环引用,已折叠)
示例
请求示例 (自动生成,仅结构参考)
POST /region/queryRegionTree
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": 1,
      "name": "",
      "parentId": 1,
      "shortName": "",
      "levelType": 0,
      "cityCode": "",
      "zipCode": "",
      "mergerName": "",
      "lng": 0,
      "lat": 0,
      "pinYin": "",
      "children": [
        {}
      ]
    }
  ]
}
处理逻辑
逻辑摘要见下方调用链
前端调用方

源码扫描未发现 7 个前端对该接口的调用(可能为开放回调/内部/未上线/管理端动态调用)

POST /region/updateRegion 未使用管理后台 #
地区信息-更新 · RegionController
基本信息
控制器com.jxxx.dscp.api.controller.region.RegionController#updateRegion
所属模块地区 region
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表region
ControllerRegionController#updateRegion
转换BeanUtils.map → Region ⇒ 表 region
ServiceRegionService#update (RegionServiceImpl)
MapperRegionMapper#updateById ⇒ 表 region

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/region/updateRegion
uathttps://dscp-uat.hn12301.net/manage-api/region/updateRegion
prohttps://dscp-uat.hn12301.net/manage-api/region/updateRegion (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

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

请求参数 · Body RegionUpdateRequest
字段类型必填取值/校验表 / 列说明
idLong必填region.id主键
nameString必填region.name地名
parentIdLongregion.parent_id父Id
shortNameStringregion.short_name简称
levelTypeInteger必填region.level_type级别
cityCodeStringregion.city_code城市编码
zipCodeStringregion.zip_code邮政编码
mergerNameStringregion.merger_name合并名称
lngBigDecimalregion.lng经度
latBigDecimalregion.lat纬度
pinYinStringregion.pin_yin拼音
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /region/updateRegion
{
  "body": {
    "id": 1,
    "name": "",
    "parentId": 1,
    "shortName": "",
    "levelType": 0,
    "cityCode": "",
    "zipCode": "",
    "mergerName": "",
    "lng": 0,
    "lat": 0,
    "pinYin": ""
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志region / 更新地区
逻辑摘要更新(regionService.update);入参与返回值经 BeanUtils 做对象/分页映射
前端调用方

源码扫描未发现 7 个前端对该接口的调用(可能为开放回调/内部/未上线/管理端动态调用)