前后端对接、封装第三方接口

对接注意事项

1. 确认接口对接的网络协议，是https/http或者自定义的私有协议等。
2. 约定好数据传参、响应格式（如application/json），弱类型对接强类型语言时要特别注意
3. 接口安全方面，要确定身份校验方式，使用token、证书校验等
4. 确认是否需要接口调用失败后的重试机制，保证数据传输的最终一致性。
5. 日志记录要全面。接口出入参数，以及解析之后的参数值，都要用日志记录下来，方便定位问题（甩锅）。

前后端对接模板

对接需要提供对接文档,一般文档中需要提供的信息如下：

1、接口URL

URL前缀：
测试环境：https://test.xxx.xxx/
生产环境：https://prod.xxx.xxx/
对应接口的URL:
admin/login-by-key
请求方式：
POST

2、接口请求参数列表

字段名	必选	类型及范围	说明
name	true	string	服务名称
POST示例：

{
  "name":  name
}

GET示例：

https://test.xxx.xxx/admin/login-by-key?name=ddd

3、响应列表

返回值字段	字段类型	说明
token	string	登陆状态鉴权凭证token
resetful标准示例：

{
  "errcode":  200,  
  "errmsg" : “ok”,  
  "data":{ 
      "token":"xxxx"
  }
}

业务梳理好、文档准备好，对接很快的

封装第三方接口

前面一段时间，连续分到三个封装http请求做二次开发的任务，记录一下，后续更新其中坑的内容。

1、 注意事项

对接文档
对接文档中的请求参数和返回示例一定要清楚，接口的权鉴和签名算法请求头拼接也一定要清楚。

提供给对接方的对接文档出问题是常有的事情，早点沟通，有问题就催，不明白的地方早点问

2、开发流程

1. 测试接口
   测试接口的可用与返回数据。
2. 请求接口
   有okhttp、 httpclient、retrofit 这些工具可以使用
   这一步经常出现数据格式错误，开发前要确定好数据与数据约束（文档的坑）。
3. 转换数据
   对获取的数据做适应性转换，封装成符合己方要求的规格。