点击上方 蓝字 关注我们!
Java,Python,C/C++,Linux,PHP,Go,C#,QT,大数据,算法,软件教程,前端,简历,毕业设计等分类,资源在不断更新中... 点击领取!
罪状一:没有文档 罪状二:文档不全 罪状三:接口参数没校验 罪状四:没保证接口原子性 罪状五:接口问题不断
罪状一:没有文档
文档是当前开发者甚至后面的接盘侠(后面开发者)能够清晰往下做的指引。
即便是简单的东西,但如果不写文档,以后口口相传消耗的工作量会比写文档更多。
好记性不如烂笔头,一段时候后,可能连开发者都忘记接口的用途。
在线文档。
本地文档。
罪状二:文档不全
{
s : 0/ 1, //表示此操作的处理状态( status ),一般简单的成功 /不成功,使用 1/0 表示。
m : 'xxxx', //表示此操作的提示信息( message ),一般只用来显示操作失败时提示信息。
r : [], //表示此操作的返回值( result )
count : x //返回的数据条数
}
{
s : 0/ 1/ 2/ 3, // 0代表正常,1是参数有误,2是用户不存在,3是用户没权限等等
m : 'xxxx', //表示此操作的提示信息( message ),一般只用来显示操作失败时提示信息。
r : [], //表示此操作的返回值( result )
count : x //返回的数据条数
}
罪状三:接口参数没校验
罪状四:没保证接口原子性
罪状五:接口问题不断
是否校验参数。
是否所有的情况都测试过了,如果可以请写单元测试。
是否返回数据准确明朗,响应状态码是否正常。
文档是否已经完备。
总结
往期推荐
END
若觉得文章对你有帮助,随手转发分享,也是我们继续更新的动力。
目前收集的资料包括: Java,Python,C/C++,Linux,PHP,go,C#,QT,git/svn,人工智能,大数据,单片机,算法,小程序,易语言,安卓,ios,PPT,软件教程,前端,软件测试,简历,毕业设计,公开课 等分类,资源在不断更新中...