api接口生成工具(api制作工具)
本篇文章给大家谈谈api接口生成工具,以及api制作工具对应的知识点,希望对各位有所帮助,不要忘了收藏本站喔。今天给各位分享api接口生成工具的知识,其中也会对api制作工具进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!本文目录一览:
1、javaapi接口文档生成工具有哪些支持struts的2、神器SpringDoc横空出世!最适合SpringBoot的API文档工具来了3、现在大公司用的API文档生成工具有哪些?分析下各种工具的优缺点,哪种工具用起来最方便?javaapi接口文档生成工具有哪些支持struts的Java语言提供api接口生成工具了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释api接口生成工具,然后使用javadoc工具来生成自己的API文档。文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。自行搜索一下javadoc即可,示例如下:java"/***类描述**@author作者*@version版本*/publicclassDemoClass{/***内部属性:name*/privateStringname;/***Setter方法*@returnname*/publicStringgetName(){returnname;}/***Getter方法*@paramname*/publicvoidsetName(Stringname){this.name=name;}}神器SpringDoc横空出世!最适合SpringBoot的API文档工具来了之前在SpringBoot项目中一直使用的是SpringFox提供的Swagger库,上了下官网发现已经有接近两年没出新版本了!前几天升级了SpringBoot2.6.x版本,发现这个库的兼容性也越来越不好了,有的常用注解属性被废弃了居然都没提供替代!无意中发现了另一款Swagger库SpringDoc,试用了一下非常不错,推荐给大家!SpringDoc简介
SpringDoc是一款可以结合SpringBoot使用的API文档生成工具,基于OpenAPI3,目前在Github上已有1.7K+Star,更新发版还是挺勤快的,是一款更好用的Swagger库!值得一提的是SpringDoc不仅支持SpringWebMvc项目,还可以支持SpringWebFlux项目,甚至SpringRest和SpringNative项目,总之非常强大,下面是一张SpringDoc的架构图。
使用
接下来我们介绍下SpringDoc的使用,使用的是之前集成SpringFox的mall-tiny-swagger项目,我将把它改造成使用SpringDoc。
集成
首先我们得集成SpringDoc,在pom.xml中添加它的依赖即可,开箱即用,无需任何配置。