【SpringBoot + Vue 尚庭公寓实战】地区信息管理接口实现(九)

本文主要是介绍【SpringBoot + Vue 尚庭公寓实战】地区信息管理接口实现(九),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

【SpringBoot + Vue 尚庭公寓实战】地区信息管理接口实现(九)


文章目录

      • 【SpringBoot + Vue 尚庭公寓实战】地区信息管理接口实现(九)
        • 1、业务说明
        • 2、数据逻辑模型
        • 3、接口实现
          • 3.1、查询省份信息列表
          • 3.2、根据省份ID查询城市信息列表
          • 3.3、根据城市ID查询区县信息列表

1、业务说明

地区信息管理共有三个接口,分别是

  1. 查询省份信息列表
  2. 根据省份ID查询城市信息列表
  3. 根据城市ID查询区县信息列表

接口定义-后台-公寓管理-公寓列表

2、数据逻辑模型

1

  • 省份信息表(Province):存储省份的基本信息。
    • 省份ID(Primary Key)
    • 省份名称
  • 城市信息表(City):存储城市的基本信息,并且包含一个外键指向省份信息表。
    • 城市ID(Primary Key)
    • 城市名称
    • 所属省份ID(Foreign Key,关联到省份信息表的省份ID
  • 区县信息表(County):存储区县的基本信息,并且包含一个外键指向城市信息表。
    • 区县ID(Primary Key)
    • 区县名称
    • 所属城市ID(Foreign Key,关联到城市信息表的城市ID
3、接口实现
3.1、查询省份信息列表

查看接口

Snipaste_2024-06-13_23-12-40

接口信息:

  • 请求地址: /admin/region/province/list
  • 请求类型: GET
  • 请求内容类型: application/x-www-form-urlencoded

请求参数:

此接口不需要请求参数。

响应状态:

状态码说明
200OK

响应参数:

参数名称数据类型说明
codeinteger(int32)返回码
messagestring返回信息
dataarray省份信息列表

data 数组中的对象结构:

参数名称数据类型说明
idinteger(int64)省份ID
namestring省份名称

响应示例:

{"code": 200,"message": "OK","data": [{"id": 1,"name": "省份1"},{"id": 2,"name": "省份2"}// 更多省份信息]
}

代码实现

// 标记该类为地区信息管理的控制器
@Tag(name = "地区信息管理")
@RestController
@RequestMapping("/admin/region")
public class RegionInfoController {// 自动注入省份信息服务@Autowiredprivate ProvinceInfoService provinceInfoService;// 定义一个接口来查询省份信息列表@Operation(summary = "查询省份信息列表")@GetMapping("province/list")public Result<List<ProvinceInfo>> listProvince() {// 从服务层获取省份信息列表List<ProvinceInfo> list = provinceInfoService.list();// 返回封装好的结果return Result.ok(list);}
}
3.2、根据省份ID查询城市信息列表

查看接口

Snipaste_2024-06-13_23-19-18

接口信息:

  • 请求地址: /admin/region/city/listByProvinceId
  • 请求类型: GET
  • 请求内容类型: application/x-www-form-urlencoded

请求参数:

参数名称参数位置是否必须数据类型参数说明
idquerytrueinteger(int64)省份ID

响应状态:

状态码说明
200OK

响应参数:

参数名称数据类型参数说明
codeinteger(int32)返回码
messagestring返回信息
dataarray城市信息列表

data 数组中的对象结构:

参数名称数据类型说明
idinteger(int64)主键
namestring城市名称
provinceIdinteger(int32)所属省份ID

响应示例:

{"code": 200,"message": "OK","data": [{"id": 1,"name": "城市1","provinceId": 1},{"id": 2,"name": "城市2","provinceId": 1}// 更多城市信息]
}
  • 请求地址:此接口的请求地址是 /admin/region/city/listByProvinceId,用于根据省份 ID 查询城市信息列表。
  • 请求类型GET 表示这是一个 GET 请求。
  • 请求内容类型application/x-www-form-urlencoded 表示请求数据需要以 URL 编码格式发送。
  • 请求参数
    • id:省份 ID,必须提供,用于指定要查询的省份。
  • 响应状态:200 表示请求成功。
  • 响应参数
    • code:返回码,整数类型,表示请求的状态。
    • message:返回信息,字符串类型,描述请求的结果。
    • data:数组类型,包含城市信息的列表。
      • id:城市 ID,整数类型。
      • name:城市名称,字符串类型。
      • provinceId:所属省份 ID,整数类型。

代码实现

@Tag(name = "地区信息管理")
@RestController
@RequestMapping("/admin/region")
public class RegionInfoController {@Autowiredprivate ProvinceInfoService provinceInfoService;@Autowiredprivate CityInfoService cityInfoService;@Operation(summary = "查询省份信息列表")@GetMapping("province/list")public Result<List<ProvinceInfo>> listProvince() {List<ProvinceInfo> list = provinceInfoService.list();return Result.ok(list);}@Operation(summary = "根据省份id查询城市信息列表")@GetMapping("city/listByProvinceId")public Result<List<CityInfo>> listCityInfoByProvinceId(@RequestParam Long id) {LambdaQueryWrapper<CityInfo> queryWrapper = new LambdaQueryWrapper<>();queryWrapper.eq(CityInfo::getProvinceId,id);List<CityInfo> list = cityInfoService.list(queryWrapper);return Result.ok(list);}}

通过这个接口,可以向服务器发送请求,获取指定省份的所有城市信息列表。前端可以根据这个接口返回的数据来展示城市信息,并实现省市县三级联动的第二级选择。

3.3、根据城市ID查询区县信息列表

查看接口

Snipaste_2024-06-13_23-24-43

接口信息:

  • 请求地址: /admin/region/district/listByCityId
  • 请求类型: GET
  • 请求内容类型: application/x-www-form-urlencoded

请求参数:

参数名称参数位置是否必须数据类型参数说明
idquerytrueinteger(int64)城市ID

响应状态:

状态码说明
200OK

响应参数:

参数名称数据类型参数说明
codeinteger(int32)返回码
messagestring返回信息
dataarray区县信息列表

data 数组中的对象结构:

参数名称数据类型说明
idinteger(int64)主键
namestring区县名称
cityIdinteger(int32)所属城市ID

响应示例:

{"code": 200,"message": "OK","data": [{"id": 1,"name": "区县1","cityId": 1},{"id": 2,"name": "区县2","cityId": 1}// 更多区县信息]
}

解释:

  • 请求地址:此接口的请求地址是 /admin/region/district/listByCityId,用于根据城市 ID 查询区县信息列表。
  • 请求类型GET 表示这是一个 GET 请求。
  • 请求内容类型application/x-www-form-urlencoded 表示请求数据需要以 URL 编码格式发送。
  • 请求参数
    • id:城市 ID,必须提供,用于指定要查询的城市。
  • 响应状态:200 表示请求成功。
  • 响应参数
    • code:返回码,整数类型,表示请求的状态。
    • message:返回信息,字符串类型,描述请求的结果。
    • data:数组类型,包含区县信息的列表。
      • id:区县 ID,整数类型。
      • name:区县名称,字符串类型。
      • cityId:所属城市 ID,整数类型。

通过这个接口,可以向服务器发送请求,获取指定城市的所有区县信息列表。前端可以根据这个接口返回的数据来展示区县信息,并实现省市县三级联动的第三级选择。

代码实现

@Tag(name = "地区信息管理")
@RestController
@RequestMapping("/admin/region")
public class RegionInfoController {@Autowiredprivate ProvinceInfoService provinceInfoService;@Autowiredprivate CityInfoService cityInfoService;@Autowiredprivate DistrictInfoService districtInfoService;@Operation(summary = "查询省份信息列表")@GetMapping("province/list")public Result<List<ProvinceInfo>> listProvince() {List<ProvinceInfo> list = provinceInfoService.list();return Result.ok(list);}@Operation(summary = "根据省份id查询城市信息列表")@GetMapping("city/listByProvinceId")public Result<List<CityInfo>> listCityInfoByProvinceId(@RequestParam Long id) {LambdaQueryWrapper<CityInfo> queryWrapper = new LambdaQueryWrapper<>();queryWrapper.eq(CityInfo::getProvinceId,id);List<CityInfo> list = cityInfoService.list(queryWrapper);return Result.ok(list);}@GetMapping("district/listByCityId")@Operation(summary = "根据城市id查询区县信息")public Result<List<DistrictInfo>> listDistrictInfoByCityId(@RequestParam Long id) {LambdaQueryWrapper<DistrictInfo> queryWrapper = new LambdaQueryWrapper<>();queryWrapper.eq(DistrictInfo::getCityId,id);List<DistrictInfo> list = districtInfoService.list(queryWrapper);return Result.ok(list);}}

这篇关于【SpringBoot + Vue 尚庭公寓实战】地区信息管理接口实现(九)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1060350

相关文章

网页解析 lxml 库--实战

lxml库使用流程 lxml 是 Python 的第三方解析库,完全使用 Python 语言编写,它对 XPath表达式提供了良好的支 持,因此能够了高效地解析 HTML/XML 文档。本节讲解如何通过 lxml 库解析 HTML 文档。 pip install lxml lxm| 库提供了一个 etree 模块,该模块专门用来解析 HTML/XML 文档,下面来介绍一下 lxml 库

Vue3 的 shallowRef 和 shallowReactive:优化性能

大家对 Vue3 的 ref 和 reactive 都很熟悉,那么对 shallowRef 和 shallowReactive 是否了解呢? 在编程和数据结构中,“shallow”(浅层)通常指对数据结构的最外层进行操作,而不递归地处理其内部或嵌套的数据。这种处理方式关注的是数据结构的第一层属性或元素,而忽略更深层次的嵌套内容。 1. 浅层与深层的对比 1.1 浅层(Shallow) 定义

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时,有没有考虑过 JVM 是如何把静态的字节码(byte code)转化为运行时对象的呢,这个问题看似简单,但清楚的同学相信也不会太多,这篇文章首先介绍 JVM 类初始化的机制,然后给出几个易出错的实例来分析,帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段,分别是:loading 、Linking、initialization

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权,允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true (Spring security默认会带有ROLE_前缀),去

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程,特意画了如下的类图,包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口,接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类,它们之间的依赖,构建起了整个框架。想要理解整个架构,最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文(security context)的信息。当前操作的用户是谁,该用户是否已经被认证,他拥有哪些角色权限…这些都被保

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物

这15个Vue指令,让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件,按住 Control 和回车键再显示它吗?小菜一碟: <template