接口设计 swagger


之前也看过很多关于接口编程的文章,很多人上来直接上代码,框架,我承认这很直接,也有可能是正在查询这个关键字的人正需要的东西。但是我觉得接口这个东西吧,其实很简单,说白了,给出框架,去完成里面的逻辑很简单。最主要的还是在设计上,不管你是采用什么框架或者什么语言。
网上总有文章来比较各个编程语言哪个好,哪个更优雅,其实语言知识工具,至于什么性能这些东西,很多人并不去考虑,如果不是那种交互性特别高的应用,who care(当然这样说是很不责任的,希望你不要那砖砸我……………..),SO,我想说的是什么?接口设计才是很重要的东西,其他的可以用很简单的方式去完成。
其实我就是想说说最近在工作中遇到事及一些想法而已,现在开始,希望各位不要吐槽…


我最近在做一个JAVA的项目,很自然的我肯定是要接触到接口,实际上我就是在原有的一个系统上进行更改和添加接口,很不愿意做的…因为原有项目的文档是手写生成的,所以在查阅和测试方面还是很让人头疼的,还有更头疼地是没有单元测试,但是就这样,还是有项目在使用它的接口。
其实这个项目在建时我也有所参与,也大概了解,那些往事就让他随风飘过吧,我知道要改项目的事情后,第一件事就是使用了swagger对接口进行了修改,正确的来说是添加了注释,注解,这样我暨了解了接口,又废弃了原来手写的接口文档,何乐而不为。对于工作量来说,相对还好,接口不算多,其实如果你不愿意写中文注释,如果代码写的好了话,swagger形成文档也能用。
我在使用swagger时,还研究了一下它。不看不知道啊,原来我以前的做法相对于来说应该是比较low,还是比较累的,因为从选框架,写接口,测试接口都一并自己做,感觉是做不完的事。在看完swagger的提供的一整套接口生态后,我沉默了….

swagger生成接口生态:
Swagger-Editor 用openapi或者swagger完成设计rest接口,再由代码生成器完成代码及框架的自动生成,你除了要选择语言及框架,剩下的就是你自己实现逻辑就好了,简直不要太爽…
我现在的做法就是用swagger直接生成JavaClient,打成jar包,然后发给身边的人使用,连http都不用写,是不是很简单但是这种只是比较适合后端语言调用,前端暂时还没试。
有时间大家还是自己去试试,我觉得挺好,
http://editor.swagger.io

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值