一款轻量级、对springboot无侵入性的api文档生成器

Dinger 专栏收录该内容
3 篇文章 2 订阅

引入jar包依赖

<dependency>
    <groupId>io.gitee.jaemon</groupId>
    <artifactId>spring-adorner</artifactId>
    <version>0.0.2</version>
</dependency>

 

api文档生成

public class AdornerApplication {
    public static void main(String[] args) {
        // 指定API文档生成路径(包括文件名)
        String filePath = "C:\\Users\\answer\\Desktop\\api\\api.md";
        // 待扫描的API接口包路径(注意修改为实际项目中的包路径)
        String packageName = "com.jaemon.demo.contorller";
        DocScanner scanner = DocScanner.of(
                Lists.newArrayList(
                    "com.jaemon.demo.contorller", 
                    "com.jaemon.demo.entity"
                )
        );

        AdornerApplicationContext context = AdornerApplicationContext.builder()
                // 文档注释扫描器
                .docScanner(scanner)
                .build(filePath, new String[] {packageName});
        
        SpringAdornerStarter.generate(context);
    }
}

更多使用特性,欢迎移步spring adorner源码 或者 spring adorner wiki

 

生成的api.md文档效果如下(简单示例)


版本修订记录

版本作者日期备注
1.0.0Adorner2021-05-01Initialization Version

 

API定义

1-query

  • 请求地址: http://localhost:8080/adorner/order/query
  • 请求方法: POST
  • 请求参数
{
	"key": "",
	"value": ""
}
  • 响应参数
{
	"code": 0,
	"message": "",
	"data": {}
}
  • 0
    点赞
  • 4
    评论
  • 1
    收藏
  • 一键三连
    一键三连
  • 扫一扫,分享海报

相关推荐
©️2020 CSDN 皮肤主题: 技术黑板 设计师:CSDN官方博客 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值