对接接口文档过程及感受

蔚落 2023-10-08 17:53 35阅读 0赞

## 1、拿到接口文档 ##

首先我们拿到接口文档，先试一下能不能走通，在此需要注意的几个点：项目地址、接口方法、参数以及请求类型。

![d70d5a16abbdacfffee188e1e8a45c36.png][]

## 2、请求接口 ##

这里我们需要用到hutool的Hutool-http，它的优点：

1.  根据URL自动判断是请求HTTP还是HTTPS，不需要单独写多余的代码。

1.  表单数据中有File对象时自动转为multipart/form-data表单，不必单做做操作。

1.  默认情况下Cookie自动记录，比如可以实现模拟登录，即第一次访问登录URL后后续请求就是登录状态。

1.  自动识别304跳转并二次请求

1.  自动识别页面编码，即根据header信息或者页面中的相关标签信息自动识别编码，最大可能避免乱码。

1.  自动识别并解压Gzip格式返回内容

如果需要Post接口，可以去hutool官网看看：[https://hutool.cn/docs/\#/http/%E6%A6%82%E8%BF%B0?id=%e4%bd%bf%e7%94%a8][https_hutool.cn_docs_http_E6_A6_82_E8_BF_B0_id_e4_bd_bf_e7_94_a8]

我这需要的是Get请求，很简单

//GET请求
    String content = HttpUtil.get(url);

这样拿到的数据就是接口返回的那种格式

![e1fd68e802bb5f9e750c4c90635b7ff3.png][]

## 3、格式转换 ##

接下来就根据自己的需求进行格式转化，下面我写一下我用到的

#### 3.1、获取String类型的data： ####

//从接口获取data
            String url = HttpUtil.get("localhost:8080/projectSettlement?page=1&limit=10");
            JSONObject urlJsonObject = JSON.parseObject(url);
            String data = urlJsonObject.getString("data");

#### 3.2、将String类型的data转换成List集合： ####

这里的DataEntity是实体类

List<DataEntity> list = JSONUtil.toList(JSONUtil.parseArray(data), DataEntity.class);

到这一步对数据做什么操作都比较方便，比如导出、存入数据库还是直接拿来用

## 4、总结 ##

总体来说还是很简单的，但是也容易遇到一下问题，如给的项目地址有改变、接口返回的数据为Null、为无，这些都会有点影响，但是无论遇到什么问题，解决就好了。

以上就是一次简单的对接接口文档的过程，如有错误，请指正！

[d70d5a16abbdacfffee188e1e8a45c36.png]: https://img-blog.csdnimg.cn/img_convert/d70d5a16abbdacfffee188e1e8a45c36.png
[https_hutool.cn_docs_http_E6_A6_82_E8_BF_B0_id_e4_bd_bf_e7_94_a8]: https://hutool.cn/docs/#/http/%E6%A6%82%E8%BF%B0?id=%e4%bd%bf%e7%94%a8
[e1fd68e802bb5f9e750c4c90635b7ff3.png]: https://img-blog.csdnimg.cn/img_convert/e1fd68e802bb5f9e750c4c90635b7ff3.png