Skip to content

Features

liuhuagui edited this page May 28, 2020 · 2 revisions

1.提供了smalldoc-spring-boot-starter及规范配置,让你在spring-boot项目中快速集成文档工具

2.基于Java源码、标准注释以及Tag生成文档,无代码入侵,保证代码清洁

3.包含大量的注释检查断言,保证开发人员的注释习惯与注释规范

4.强大的参数配置语法,满足开发者对参数展示的各种要求

5.支持实体参数,泛型字段,集合字段,关联实体等复杂参数的自动解析

6.支持忽略解析指定包或指定类型参数的数据结构

7.可配置的解析类名,支持正则匹配

8.支持多模块及第三方依赖

9.支持微服务文档集成

image 参考文档

  1. 将其他服务的源码路径以及包名配置出来,
  2. 最好在每个包下增加一个package-info.java文件,
  3. 给该文件添加功能注释—— 比如,你的模块功能名称。
  4. 可以给注释增加@urlTag ,这样该 Tag 指向的url就会覆盖你默认的url —— 每个包都可以拥有不容的访问路径。 image image

10.对UNIX系统做了兼容

11.支持接口参数示例值推断

12.集成了API测试功能

13.提供了友好的默认UI,支持离线文档生成;

14.提供了文档RESTEful API,支持实现自定义UI;