![](https://img-blog.csdnimg.cn/20201014180756927.png?x-oss-process=image/resize,m_fixed,h_64,w_64)
接口设计
文章平均质量分 87
DailyPractice
这个作者很懒,什么都没留下…
展开
-
优雅打印接口调用时长
引言优雅的API设计不仅仅是代码层面的书写规范.几乎不可能API开发完毕就能正常投入使用,更多的是对细节的打磨.例如接口的每次执行时间,入参都会在API测试中反复的推敲思考如何设计一个方案使开发者能一目了然的可视化接口的处理时间以及入参是否正确呢?思路首先想到的是Spring的AOP切面,现在我们编写API接口,一般都会把接口写在controller控制层里,按照不同的业务,分为写在不同业务包下的controller类中.大致的架构如下:按照这种控制层的编写规范,只需要用切面找到每个业务包下.原创 2021-01-12 11:07:19 · 678 阅读 · 0 评论 -
编写令人愉悦的API接口(二)
引言制定API接口的规范在设计接口时尤为重要,统一的格式规范会减少联调的难度,也能让后续维护者身心愉悦.在编写接口时,运用适合的参数检验技巧也能提高代码的健壮性.本文将围绕这两点详解一些我的一些经验.思考业务接口通常都包含最基础的CRUD操作,怎么尽可能的统一这部分接口?API接口部分会使用到HttpServletRequest和HttpServletResponse里的数据,如何方便的获取到这两个对象?接口的参数有时通过单个参数传递,有时会通过对象传递,如何方便的检验这些参数,而不用频繁的使.原创 2020-12-24 14:32:51 · 374 阅读 · 2 评论 -
编写令人愉悦的API接口(一)
引言API接口是服务端与客户端沟通的桥梁.较好的API设计能减少客户端与服务端的联调时间,更加关注于自己本身代码的优化与业务层的逻辑.API设计知识点[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-f6Dley2S-1608710367590)(http://photo.chenyunxuan.com/blog/202016087095371020.png)]API组成良好的API接口应该从这下面几个方向进行优化准确的API协议准确的内容类型统一的返回类型以.原创 2020-12-23 16:00:40 · 347 阅读 · 0 评论