-
罪状一:没有文档 -
罪状二:文档不全 -
罪状三:接口参数没校验 -
罪状四:没保证接口原子性 -
罪状五:接口问题不断
罪状一:没有文档
-
文档是当前开发者甚至后面的接盘侠(后面开发者)能够清晰往下做的指引。
-
即便是简单的东西,但如果不写文档,以后口口相传消耗的工作量会比写文档更多。
-
好记性不如烂笔头,一段时候后,可能连开发者都忘记接口的用途。
-
在线文档。
-
本地文档。
罪状二:文档不全
{
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-
PS:欢迎在留言区留下你的观点,一起讨论提高。如果今天的文章让你有新的启发,欢迎转发分享给更多人。 Java后端编程交流群已成立 公众号运营至今,离不开小伙伴们的支持。为了给小伙伴们提供一个互相交流的平台,特地开通了官方交流群。扫描下方二维码备注 进群 或者关注公众号 Java后端编程 后获取进群通道。 —————END————— 推荐阅读:
SpringBoot+vue.js搭建图书管理系统 i++ 是线程安全的吗? IDEA 卡成球了 !咋优化 ? 最美的Vue+Element开源后台管理系统 基于SpringBoot的迷你商城系统,附源码! IntelliJ IDEA 2020.2.4款 神级超级牛逼插件推荐

最近面试BAT,整理一份面试资料《Java面试BAT通关手册》,覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。 获取方式:关注公众号并回复 java 领取,更多内容陆续奉上。 明天见(。・ω・。)ノ♡
原创文章,作者:栈长,如若转载,请注明出处:https://www.cxyquan.com/10754.html