当前位置:首页 > 建站优化 > 正文内容

如何优雅的生成接口文档?

zhuangbi888.com2021-04-09 07:33建站优化6

我们知道在项目开发阶段,接口文档基本上是必备产物了,一般由后端开发人员提供,作为和前端人员进行前后端接口联调的桥梁,或者与别的项目模块进行交互提供指导等等,接口文档的准确性,实时性,详细与否等,都会极大的影响前面的操作。那么如何才能优雅的生成接口文档呢?

其实对于做开发的大多数人来说,多多少少都听过swagger,它是一个较为流行的接口文档管理工具,使用起来非常方便。所以大多数人都会使用swagger来生成接口文档,但是今天我要介绍另外一种生成接口文档的方式。通过swagger插件(如jar包)解析编写了接口注解的java代码, 而后通过生成的swagger.json文件解析出接口信息并导入接口文档管理工具yapi(yapi是去哪儿的大前端团队开发,基于react+antd的一套接口文档管理工具)。具体操作步骤如下:

编写注解

图中的@POST, @ApiResponses, @Path等意思都很明显,因为我的java只有一点点语法基础, 所以理解可能有点出入, 我这里简单理解为注释的意思。如有不对求指教。

这个类里面, 有user和login属性, 分别给属性加了类似这样的注解

通过注解生成swagger.json解决好pom文件的依赖后。在项目目录执行:mvn clean compile

导入yapiyapi是去哪儿的大前端团队开发,基于react+antd的一套接口文档管理工具,可以自己下载体验下,真心不错。至于不需要yapi, 钟爱原生swagger的童鞋, 也可以直接将swagger.json放入你的本地swaggerUI中查看接口文档。

当然这种方法有个缺点就是开发需要在每个model的类加上注解, 写每一个接口也需要注解,这里只是提供另外一种生成接口的思路。

如果觉得笨猫的回答对你有用,点个关注谢谢。

相关文章

域名备案审批号是什么(为什么org域名不能备案)

域名备案审批号是什么(为什么org域名不能备案)

题主问的是typingclub网站加载慢的问题,楼下回答的都文不对题啊。 typingclub是一个在线打字的网站,能够通过课程和游戏,使用手指合理掌握键盘每个分区,很多国内帖子都在安利它。现在的打字...

江门市蓬江区艾网科技有限公司介绍?

江门市蓬江区艾网科技有限公司介绍?

简介:江门市蓬江区艾网科技有限公司成立于2015年05月22日,主要经营范围为软件及网站开发,网站建设等。法定代表人:余伟文成立时间:2015-05-22注册资本:50万人民币工商注册号:440703...

沈阳网站建设最好(沈阳网站建设 房小二)

沈阳网站建设最好(沈阳网站建设 房小二)

首先h5不是一项技术,而是一个标准,一个技术的集合. 其次就要知道什么是HTML语言, 它是一种描述性语言,全名“HyperTextMarkupLanguage(超文本标记语言)”,我们所使用的页面就...

网站建设行业新闻(网站建设行业 百度竞价推广 转化成本 元)

网站建设行业新闻(网站建设行业 百度竞价推广 转化成本 元)

感谢邀请回答,我可以完整的回答你这个问题。首先我要说明一个客观事实,任何行业都有赚钱的,任何行业也有不赚钱的。你的思路决定大部分你的发展。很多不赚钱的,失败的人,就开始找各种理由。说行业不好做,竞争大...

网站缩放快捷键(web同比例缩放代码)

网站缩放快捷键(web同比例缩放代码)

你可以重置下MAX的快捷键设置或者进入快捷键设置界面找到缩放命令然后指定快捷键R就好。 重置和设置快捷键在Customize(自定义)--Customize User interface(用户自定义)...

反链是什么意思是什么(网站外链是什么意思?)

反链是什么意思是什么(网站外链是什么意思?)

外链就是指从其他网站导入到自己网站的链接。举例说明:对于任何网页A来说,任何一个其它的网站B,如果网页B给网页A做了链接,那么这个链接相对于网页A 来说,就是一个外链。做外链对于网站优化来说是非常重要...

百度做网站推广的费用(网站推广维护应该怎么做)

百度做网站推广的费用(网站推广维护应该怎么做)

  费用预算及规划 季度预计投入:(湖北省内)(具体花费还是要根椐客户搜索量和关键词的价位) 体验期:1500~2000(效果不明显,同时协调各方面配合。计算回报比) 100...

关于保护环境的英语作文模板(关于保护环境活动的通知模板)

关于保护环境的英语作文模板(关于保护环境活动的通知模板)

作文在考研英语中所占比例较大,英语(一)占30分,英语(二)占25分。小作文为应用文,主要为书信、备忘录、报告、告示四大文体。大作文英语(一)一般为图画作文,英语(二)一般为图表作文,但不排除交换形式...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。