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

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

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

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

其实对于做开发的大多数人来说,多多少少都听过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的类加上注解, 写每一个接口也需要注解,这里只是提供另外一种生成接口的思路。

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

相关文章

拼音域名有什么价值?

拼音域名有什么价值?

主要分比较主流的单拼域名、双拼域名和三拼域名来说。 单拼域名 按照中文拼音组合来说,最短的就是像“mi、du”这样由两个字母组成的,像这种两字母域名,我们也可称为“单拼”域名,这类域名品相极佳,兼具两...

杭州市建设网站(杭州市建设网官方网站)

这个问题太容易了,会很好。 首先,杭州有中国互联网的一极,阿里巴巴,这个巨头会源源不断地为杭州吸引人才,贡献创业资金。 根据统计,杭州目前已经成为中国最吸引人才流入的城市。 杭州电商产业链发达,拥有诸...

域名怎么做cname解析?

域名怎么做cname解析?

域名 CNAME 解析设置方法: 1、登录阿里云/万网【管理控制台】。 2、点击主导航栏【产品与服务】--【云解析】,进入域名解析列表页。 3、点击要解析的域名,进入解析记录页。 4、进入解析记录页...

电脑怎么做网站赚钱(电脑做网站的软件有哪些)

电脑怎么做网站赚钱(电脑做网站的软件有哪些)

真的,一天赚50块确实是很简单,也比较符合实际,很多人问的问题动不动就说怎样月薪过万,5万本金做什么能月薪过万等等。这种人恐怕钱掉到他眼前,他还在问赚钱怎么这么难,非要他人把钱送到他口袋里,他在觉得赚...

如何查看域名隐私保护(cn域名隐私保护)

如何查看域名隐私保护(cn域名隐私保护)

如何设置域名隐私保护服务? 当您在注册商成功注册域名后,你的姓名、联系地址、电话、Email 等注册信息将被存储到域名 whois 信息数据库中,任何人都可公开查询到这些信息,隐私无法保障。 域名隐私...

org后缀的域名含义(域名后缀有哪些)

org后缀的域名含义(域名后缀有哪些)

网址中最后的.org是域名类型,意思是:各类组织机构或非盈利团体性质的域名。在注册方面,org域名的资格没有任何限制,任何一个国家的个人或企业均可注册。.org域名是互联网的通用顶级域之一,“org”...

南阳集团网站建设(南阳建设投资集团有限公司官网)

南阳集团网站建设(南阳建设投资集团有限公司官网)

今天给各位分享南阳集团网站建设的知识,其中也会对南阳建设投资集团有限公司官网进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!文章目录列表: 1、请帮忙推荐南阳信誉好的建站公司!...

网站制作模板(网页设计制作网站模板)

网站制作模板(网页设计制作网站模板)

本篇文章给大家谈谈网站制作模板,以及网页设计制作网站模板对应的知识点,希望对各位有所帮助,不要忘了收藏本站喔。 文章目录列表: 1、怎么做网站模板 2、网站模板制作的一些问题 3、如何制作网站...

发表评论

访客

看不清,换一张

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