API 开发的心得总结
来源:互联网 发布:如何优化标题 编辑:程序博客网 时间:2024/05/09 08:35
最近开发公司SDK的支付API。对API有有一点点心得,记录下来。
一、数据安全
1.通信协议
尽量使用HTTPS
2.签名加签
使用双方约定的算法,发送方对数据进行加签,相应的接受方需对数据进行验签。防止数据被篡改。加签/验签需要的 “盐”或者密钥单独保存在服务端。不在通信中传递。
3.加密(非必须)
可对传递的信息使用加密算法进行加密。
二、程序设计
1.数据验证
对接受的数据进行严格验证:参数类型,参数必须性。
2.Log系统
①设计完善的日志系统。将接收、发送的数据做日志记录下来。需保证Log存放的安全性。
②在程序对数据进行验证或判断处,对验证失败的信息记log。方便调试,如:API被合作公司访问,但由于验证问题,无法正常获取信息。这种时候有个log很容易找到的问题的根源,通常是对方未按照约定对数据加签或者参数错误。
3.错误信息
数据验证不通过时返回适当的错误代码。方便请求API的工程师调试。
三、API文档编写
1.文档编写力求简单明了,逻辑清晰。对接口参数的必须性,参数类型描述清楚。适当时候可给出示例的应用场景。
2.文档对API的描述必须合乎的API的逻辑,对容易混淆的参数字段给出醒目的标识。
阅读全文
0 0
- API 开发的心得总结
- API设计的一些心得总结
- IOS开发心得总结
- 前期开发心得总结
- angularJS开发心得总结
- Windows 系统 的 SDK 程序开发心得 小总结
- Linux开发心得总结10 - MIPS TLB 的结构(translated)
- Linux开发心得总结19 - 进程的虚拟空间
- 开发以及团队管理方面的心得总结
- [心得]基于Flask技术的web博客开发总结
- 开发完成后总结心得
- S3C2410X开发总结及心得
- 开发完成后总结心得
- Android SDK开发心得总结
- Android Camera Api的心得
- Android Camera Api的心得
- ArcGIS API for Javascript 开发经验心得
- arcgis api for js开发心得
- ios封装多张图片点击任意UIImageView放大图片
- 版本控制——SVN简介
- Spring源代码解析
- cmd打开文件
- ShaderLab基础语法
- API 开发的心得总结
- php自带压缩方法的性能比较
- 自定义可滑动的按钮
- 淘淘商城系列——maven工程debug调试
- cxf环境搭建与第一个项目
- [BZOJ2795] [Poi2012] [字符串hash] A Horrible Poem
- 在orangePi上启动MAVProxy的方法
- Codeforces Round #416 (Div. 2) ABC
- JSON的序列化与反序列化及其在前后台交互中的应用