admin 管理员组

文章数量: 1184232


2024年3月20日发(作者:parse response)

软件开发接口文档问题

软件开发过程中,后台接口不规范导致的问题总结,

现在后台接口规范应该学习restful 风格,具体参考网上资料

1.文档存放问题

目前存放是这种状态:

1.1 文档杂乱

分不清哪些是不用的接口,哪些是正在用的接口,哪些是更新后的接口

1.2 接口查询效率慢

word格式管理,不方面查询

1.3 多个word文件,下载操作麻烦

每次查看接口,需要下载word,不能避免下载操作查看,效率不高

2. 文档分工问题

2.1 接口文档的编写

后台统一提供接口,没有考虑到数据解析的便利性,客户端解析带来一定的不可避免

的性能,逻辑方面的费时【例如排序问题耗费性能】,不利于最终客户的体验;

2.2 接口返回格式定义的问题需要解决

后台接口开发人员负责编写


本文标签: 接口 问题 后台 下载 文档