1 Star 0 Fork 1

蜀黍凯 / smalldoc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

项目

一个基于Java标准注释的 RESTful API 文档生成及测试工具。

为什么要造轮子?

  • 强迫症患者,接受不了 Swagger 的各式注解对代码的入侵造成的冗杂,更渴望清洁的代码;
  • 注解的使用需要一定的学习成本;
  • 随后尝试使用 Apidoc ,尽管Apidoc是基于注释生成文档,但是学习成本并没有降低,你需要学习额外的注释 Tag ,同时你不得不使用这些特殊的 Tag 将你所需接口的相关信息手动写出来,感觉并没有降低书写文档的工作量;
  • 也有一些基于Java标准注释生成文档的项目,但是有的无法支持实体参数泛型变量,无法支持多模块第三方依赖微服务文档集成;有的Bug太多,UI界面不够友好;有的使用方式过于复杂(需要依赖Maven插件和繁琐的配置),甚至逻辑处理上存在问题。
  • 如果一个API文档同时集成了类PostMan的测试功能,一锤搞定,不用在API文档PostMan或RestClient之类的测试工具间频繁切换,难道不香吗?

特性详情可见

  • 提供了smalldoc-spring-boot-starter及规范配置,让你在spring-boot项目中快速集成文档工具
  • 基于Java源码、标准注释以及Tag生成文档,无代码入侵,保证代码清洁
  • 包含大量的注释检查断言,保证开发人员的注释习惯与注释规范
  • 强大的参数配置语法,满足开发者对参数展示的各种要求
  • 支持实体参数,泛型字段,集合字段,关联实体等复杂参数的自动解析
  • 支持忽略解析指定包或指定类型参数的数据结构
  • 可配置的解析类名,支持正则匹配
  • 支持多模块及第三方依赖
  • 支持微服务文档集成
  • 对UNIX系统做了兼容
  • 支持接口参数示例值推断
  • 集成了API测试功能
  • 提供了友好的默认UI,支持离线文档生成;
  • 提供了文档RESTEful API,支持实现自定义UI;

文档

documention

快速使用

quick start

空文件

简介

Zero-intrusion Java Restful API documentation tool based on code comments. 展开 收起
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/51Bigod/smalldoc.git
git@gitee.com:51Bigod/smalldoc.git
51Bigod
smalldoc
smalldoc
master

搜索帮助

14c37bed 8189591 565d56ea 8189591