聚合数据 自己定义接口 超简单demo

第一步**

我们首先知道 聚合数据 这个网站
我们具体的架构 都是参考 聚合数据这个网站的 如果你比较了解的话 可以 快速往下看

这和个网站里面有大量的接口,我们可以根据别人提供的文档来调用接口,这不过这是别人编辑好的接口
在这里插入图片描述
在这里插入图片描述

第二步

关于那个网站,读者可以自己去玩一玩,
那么重点是 我们如何设计一个接口,因为 公司会有大量,这种编写接口的业务。

① 编写接口文档**

② 错误码

一般在编码过程中,经常需要抛出异常;举例:假设后台有一个根据订单号查询订单的接口,假设有人没有传订单号来使用我们这个接口,这种请求我们认为是非法操作,所以我们需要给用户一个提示信息,一般通过自定义异常在控制器接收异常,封装成用户能看懂的错误提示,控制器再往上抛异常用户看到的就是一堆看不懂的异常,一般是返回错误码或者说明的方式;
这里要用到的知识点:
枚举、常量类封装错误消息
自定义异常
把自定义异常封装到json返回给用户

第三步 :直接进入主题 创建工程

1:创建一个新的web工程 由于这里只是个demo 所以不需要连接db

pom里面不需要大量的依赖 只需要基本的web即可

标题2:创建实体类

在这里插入图片描述
这个接口 大家都应该知道 所以不做具体介绍,然后需要 get set 方法 所以使用@data注解 需要导入lombok依赖 以及小辣椒插件

3:封装通用的返回工具类

这里做的是添加一个对象,所以定义成功或者失败两个种结果的方法以及不同的返回值,里面的三个属性 参考“聚合数据网站”里面的返回值json
在这里插入图片描述 4:自定义异常
报错后 会自动走 定义的异常
这里的属性 用于装错误码 使用父类的message装错误信息,让用户能看懂在这里插入图片描述
5:定义service
service中可以按照如下的方式去抛出异常,但是“200”,“名字不能为空”,两个字符串写死了,看着显得不专业,所以需要把这两个字符串抽取出去,将来如果复用也方便。所以在这里可以引入枚举。
所以先创建枚举,再写service
在这里插入图片描述
由于这个只是一个简单的demo,所以数据不是从db查出来的,只是简单的模拟一下在这里插入图片描述
6:定义controller 这里只需要会简单的spring mvc 完全可以看懂
由于service是抛异常,如果web继续抛异常,那么报错信息就会显示到页面上,客户没有编程技术,会感觉特别不专业,所以需要try catch 处理
在这里插入图片描述
6:最后 演示效果
这里没有给 username password 赋值在这里插入图片描述
在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/qq_43595647/article/details/89294371