「Offer 驾到,掘友接招!我正在参与2022春招系列活动-经验复盘,点击查看 活动详情」
背景介绍
- 我是一名PHPer后端工程师
- 为了给孩子凑学费,网上接了个兼职的工作,是做前端
- 项目后端是java写的,我负责的前端用的是 vue-element-admin
- 后端是一名十年的java老技术,见过一次。后期交流都在网上
某一日
项目经理让做新模块,一个文库模块的增删改查。后端大神花了几天搞完,然后给了我一个文档。文档的具体内容是写的列表、增删改四个接口。我们来看看文档增加的这个接口中存在的问题。
问题1
POST请求,将所有的参数都整上去了。不管怎么调整,永远都只会报 500的错误。晕乎乎的都不知道错在那里。
问题2
跟大神沟通,大神说文件传递那个参数是文件。我就纳闷,同步表单提交文件的方式早就不用了,文件都是异步上传。大神还给我整了个同步表单提交。
问题3
post提交的数据,本来都该在Body中,可大神却把参数都放在 Query参数中。这样我就百思不得其解。难道是要我把参数都拼接到url参数中,单独那个文件放到数据中?
各种的尝试,各种的拼接参数,拼接表单,还一直只有一个 500的错误,跟大神沟通,大神始终说接口没问题。终于在我奋斗了两天以后,彻底的宣告失败,无奈只能让大神改接口
总结
作为一个后端开发者,我们写的接口无非就是,请求方式,参数。但是所有写出的接口都是给别人看的,既然是给别人看,那文档一定是要写的很详细的。这是一个工作态度的问题
。当你决定去写一个接口,那文档也必须详细,如果写的马马虎虎让前端去猜,那前端肯定是会骂你的。
附录
附录一个我感觉自己不会被骂的一个接口文档。