开放API设计的几大要点
发布时间：2022-11-24 17:18:23 来源：本站编辑：GD工单系统
知识导读
在近些年的工作上，对接过很多其他企业的开放API接口，可是接口文档没有一个所写的较为完美，许多这里叙述不太清楚，便是缺乏对应的实例。作为一个开发设计对接者，取得这种API，非常少头痛，没法，只有针对该疑问跟合作方进行交流确定，不仅消耗彼此人力资源管理，并且高效率较为不高。现在又对接了俩家合作开放API，甚为难受，已开始怀疑人生，便决定发布一下自己的想法，存在的不足还希望各位朋友多多指点。最先总结一下对接的API文档上存在的一些问题：
1、一个合作方，给予2套非单独的API文档，每一个API里的接口都要对接这类API文档在日常工作中只经历过一次，是哪个公司我不公布了，并且2套API要求的网站域名也不一样，还好验签方法及其验签密匙是一样的。
2、接口文档是现所写的，是第一次对接，那种感觉就是一个实验品这类第一次对接的API接口文档，对接全过程实际上是帮合作方进行测试全过程，对接全过程遇到的困难，解决不了就调节接口，这类最讨厌，以前的对接写完了很有可能没有用，必须重新写，造成无效工作，消耗时间。
3、接口文档并没有对接详细步骤绝大多数不太完善的文档，都缺乏对接流程说明，这就使得在具体对接时需要跟合作方沟通交流接口对接步骤，顺序，及其接口间的依存关系，有所不同企业中间技术的沟通交流，通常是高效率最少小一点。
4、接口字段名缺乏必需表明和叙述有一些小企业也会存在那样一些问题，碰到这种文档，我一般回绝对接，就会直接规定合作方填补完字段名表明后再进行对接。字段名实际意义不清楚，数据信息不知道该怎么用，还怎么开展对接。
5、验签标准有表明但不给予简易实例这类API文档，假如没给验签实例得话，在对接实验过程中容易出现验签不成功的状况。终究程序猿水准不一样，验签标准一样，写出的代码逻辑不一定能确保是一样的，这时候假如拿API里的验签实例认证一下自己的签名编码，最好不过了。自然，有些好一点的API文档，就会直接给予各国语言的签字形成实体类，立即copy引入就可以，省掉许多研发工作。
Tag： 开放API 开放API系统 开放API软件