关于写查询接口的一些理解

背景

在上一篇文章中,我们讲解了如何编写查看设备详细信息的接口。这篇文章中,我们将讨论一般查询接口的编写方法。为了便于理解,我们将以一个最简单的查询为例,详细讲解如何编写查询接口。

了解接口需求

这是写IT设备查询接口的要求:

首先要明确的是,编写任何接口都是针对某张特定的表进行操作的。以这个接口为例,我们针对的是IT设备信息表。我们的目标是通过IT设备信息表中的某几个字段作为查询条件,筛选出符合条件的行记录。

例如,我想查询组织机构(orgId)等于35的行记录。当你传入参数orgId=35时,我希望返回这张表中所有orgId等于35的行记录。

明确接口的目的之后,就可以开始编写代码了。首先是编写controller层。在controller层中,主要需要处理的是传入的参数和返回的VO。传入的参数在图片中已经圈出来了,主要是几个字段,而返回的参数则是这张表的所有字段。

那就开始写吧!不过这次不是我自己写,而是找AI帮忙。我会把我想要写的东西描述清楚,然后让AI帮我写。最终,controller层的代码就会完成,效果如下:

接下来是编写service层。由于这个接口的service层非常简单,没有复杂的业务逻辑,所以不需要花太多时间。最终,service层的代码如下:

最后,我们进入mapper层,编写SQL语句。首先,我们需要理清这条SQL语句的逻辑:通过表中的某几个字段(也就是上图中的条件查询字段),查询出整张表的所有字段。这条SQL语句非常简单,甚至不需要关联其他表。

接下来要做什么?对,就是把你的想法告诉AI,让AI帮你写这条SQL语句。写完后,如果没有报错,mapper层就完成了。

然后,我们可以用Postman测试一下这个接口。如果测试没有问题,这个查询接口就算完成了。

这就是最简单的查询接口。基本上,其他复杂的查询接口与这个接口非常类似。区别在于:service层的逻辑可能会多一些,mapper层的SQL语句可能会复杂一些,仅此而已,除此之外,并无大差别。

猜你喜欢

转载自blog.csdn.net/qq_54432917/article/details/143214225