首页
沸点
课程
数据标注
HOT
AI Coding
更多
直播
活动
APP
插件
直播
活动
APP
插件
搜索历史
清空
创作者中心
写文章
发沸点
写笔记
写代码
草稿箱
创作灵感
查看更多
登录
注册
确定删除此收藏集吗
删除后此收藏集将被移除
取消
确定删除
确定删除此文章吗
删除后此文章将被从当前收藏集中移除
取消
确定删除
编辑收藏集
名称:
描述:
0
/100
公开
当其他人关注此收藏集后不可再更改为隐私
隐私
仅自己可见此收藏集
取消
确定
规范
订阅
draymondgewade
更多收藏集
微信扫码分享
微信
新浪微博
QQ
16篇文章 · 0订阅
技术·文档 | 标准API文档规范 1.0
随着业务的发展,支撑平台的项目也是越来越多。 同时,为了让业务系统更加清晰,会从整个平台项目的架构体系,对系统业务水平拆分、垂直分层,产生了一系列平台和子系统,并使用接口进行数据交互。 伴随着业务的发展,接口文档会越来越多。 代码和文档不匹配,代码接口更新,文档不更新,且接口文…
无需额外注解的 SpringBoot API文档生成工具
大家好,我叫叶大侠,一名独立开发者。这个文档工具是我17年的一个想法,当时还是在公司里面上班,负责App客户端的开发工作,当时后端童鞋写文档的意愿比较低,总是要等他们开发完接口,然后才在微信上沟通接口细节,显然这样的效率很低,导致前端的童鞋总是差不多deadline的时候才猛加…
支付系统 - Swagger 的快乐你不懂[减压文]
经常和前端联调的时候,需要提供文档(就很烦)。如果是自己新写的接口还好,怕就怕是之前的老接口,各种返回值的逻辑都不太清楚了,找原来的文档又找不到,找到了还一定是最新的。此时,我就在想能不能搞个东西让它自动生成文档。解决一下这个文档不跟着代码走的老大难问题。 好在是,优秀的人总是…
如何代码命名
There are only two hard things in Computer Science: cache invalidation and naming things. —— Phil Karlton 开发人员习惯性的对设计、架构、微服务夸夸其谈,却很少关注设计、架构…
一般人不敢动系列之—基于logback的日志“规范”和“脱敏”
在日常开发中,我们经常会使用logback打印日志,还会包含一些敏感内容。比如手机号、卡号、邮箱等,这对数据安全而言是有风险的。 但是如果让业务去处理这些问题,则需要在每个打印日志的地方,进行重复的脱敏操作,不仅繁琐影响代码风格,还会有遗漏情况。 这个时候,我们就需要考虑一个相…
MySQL开发规范
最近看到一份MySQL开发规范,受益颇多,规范里隐藏了很多MySQL的原理,大家有兴趣可以分析一下这些规范被如此设定的原因。 库名、表名、字段名、索引名必须使用小写字母,并采用下划线分割。 库名、表名、字段名支持最多64个字符但禁止超过32个字符。 库名、表名、字段名必须见名知…
过来人写给软件工程师的 30 条建议
就在几天前,我的人生迈入了30岁。在过去的十年中,我做了很多事情,也学习了很多东西。在本文中,我将回顾人生的历程,并将软件工程师的工作和生活公之于众。下面,让我们进入正题。1,努力工作没有人会平白无故
API怎么选?比较SOAP、REST、GraphQL和RPC
我们知道,两个单独的应用程序需要中介程序才能相互通信。因此,开发人员通常会搭建桥梁(应用程序编程接口),以允许一个系统访问另一个系统的信息或功能。 为了快速、大规模地集成应用程序,API是使用协议或规范实现的,这些协议或规范定义了通过网络传递的消息的语义和语法。这些规范组成了A…
CleanCode之方法级模板方法
1. 起因 红框内的代码是重复的(除了log日志打印的描述信息不同外),对于代码极简主义者,不由想把它优化掉。 2. 重构 2.1. 初次重构想法 看起来真的很接近,但模板方法模式是”多个子类“继承一个父类,每个子类可以有不同的行为(可变部分),而当前的场景是”一个类中的多个方…
技术总监手把手教我如何消除项目中丑陋的Try{}Catch{},获益匪浅
软件开发过程中,不可避免的是需要处理各种异常,就我自己来说,至少有一半以上的时间都是在处理各种异常情况,所以代码中就会出现大量的try {...} catch {...} finally {...} 代码块,不仅有大量的冗余代码,而且还影响代码的可读性。比较下面两张图,看看您现…