零注解无侵入API接口文档生成神器smart-doc

smart-doc是一款强大的接口文档生成工具,无需注解,仅需标准JAVA注释即可。本文将介绍如何通过maven插件配置、添加smart-doc.json文件,以及在IDEA中和命令行方式生成Markdown、HTML等格式的API文档。
摘要由CSDN通过智能技术生成

smart-doc是什么?

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,零注解、零学习成本、只需要写标准JAVA注释,smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。

smart-doc怎么用?

1、Add Maven Plugin
<plugin>
    <groupId>com.github.shalousun</groupId>
    <artifactId>smart-doc-maven-plugin</artifactId>
    <version>2.2.4.1</version>
    <configuration>
        <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
        <configFile>./src/main/resources/smart-doc.json</configFile>
        <!--指定项目名称-->
        <projectName>
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值