当前位置: 首页 > 网络应用技术

Springboot生成接口文档,我使用Smart-Doc,而不是Swagger!

时间:2023-03-05 16:39:41 网络应用技术

  我曾经在Springboot Old Bird系列中花费大量空间,以详细整合Swagger以及如何扩展Swagger来支持接口参数分组功能。像这样玩!

  但是,当我与另一个接口文档工具接触时,我认为它更适合于该项目集成,而不是Swagger,更适合老鸟。鸟类系列。

  首先,让我们看一下Swagger组件中当前存在的主要问题:

  作为比较,它基于对接口源代码生成接口文档的分析,并且完全分散和入侵。您只需要按照Java标准编写即可。Smart-Doc可以帮助您生成简单的降价或GitBook样式,例如gitbook stylestatic html document.fificial地址:

  只需列出Smart-Doc的优势:

  让我们看一下如何将Smart-Doc集成在Springboot中。

  Smart-Doc支持多种生成接口文档的方法:Maven插件,Gradle插件,单元测试(不建议)。在这里,我使用Maven插件。步骤如下:

  专注于指定智能-Doc配置文件

  指定由Smart-Doc生成的文档路径,其他配置项目可以参考官方Wiki。

  当然,您还可以在想法中生成maven插头

  4.访问接口文档

  生成接口文档后,我们可以检查它。效果如下:

  看到这里的同学可能会微笑,就是这样吗?您要我代替Swagger吗?

  不用担心,我只是体验了Smart-Doc的基本功能。接下来,我们通过丰富SMART-DOC的配置文件的内容来增强其功能。

  良好的接口文档工具调试功能必须不小。Smart-Doc支持在线调试功能。您只需要添加以下配置项目:

  通过“ CreateDeDebugpage”将调试函数放置:True,并在Smart-Doc生成文档时直接放置它。这可以直接启动程序访问页面进行开发和调试。

  一些开发人员在想法中使用[在浏览器中打开]来打开Smart-Doc生成的调试页面。如果是这样,前端JS请求背景接口将出现交叉域。因此,您需要在后端配置交叉域。

  这是Springboot2.3.x作为配置背面 - 端交叉 - 域的示例:

  打开交叉域后,我们可以在静态接口页面上进行调试。

  在文章“ Springboot如何到达后端以返回格式?老鸟都像这样演奏!”在一篇文章中,我们打包了所有返回值,并将统一的数据结构结果返回到前端。我们需要让它在接口文档中,也是此功能,在配置文件中添加配置内容:

  在前端和后端分离项目中,我们通常需要在请求接口(例如令牌,授权等)时设置一个请求标题。.....后端判断是否是根据请求进行的系统法律用户标题。目前,Smart-Doc还提供了它。

  继续在Smart-Doc配置文件中添加以下配置内容:

  效果如下:

  演示Smart-Doc对参数数据包的支持

  当添加操作时,需要年龄和水平,并且性别不兼容。

  在操作过程中,需要ID,Appid,Leven,并且性别不兼容。

  可以通过上述效果看出,Smart-Doc由参数数据包完全支持。

  自定义标签默认值不会自动提示,并且需要在Idea中设置用户。设置后,您可以使用它。以下设置以将Custom-Doc自定义模拟标签设置为示例。设置操作如下:

  附加完整的配置,如果您仍然需要其他配置,则可以参考Wiki自我介绍。

  实际上,没有什么可总结的。使用DOC非常简单,并且官方文档非常详细。只要您编写标准Java注释,就可以生成详细的接口文档。(如果您说不能写评论,本文可能不适合您。)介绍Smart-Doc,您也可以强制强制强制开发人员对接口进行评论,以确保团队代码样式不会大不相同。

  旧鸟类系列的源代码已上传到GitHub,所需的公共帐户[Java Nikko]回复关键字0923获取