logo

• 简单易用的 Java 接口文档生成器,基于 JavaDoc 风格的注释生成接口文档,对代码 0 侵入。
• 提供接口展示,对象展示,调用测试,全局参数配置等功能,目前最新稳定版本1.3.0,可以通过 maven 或者 gradle 直接使用
• 支持网关和服务模式,通过配置文件决定
• 支持通过 url 分享指定接口或者对象

• 通过 service_ip:port/easy-doc.html 的方式访问
• 通过 service_url/easy-doc.html 的方式访问

gateway

service

controller

model

global

设计思路文档

• 远程仓库地址
• 使用maven引入

<dependency>
 <groupId>com.stalary</groupId>
 <artifactId>easy-doc</artifactId>
 <version>${version}</version>
</dependency>

• 使用gradle引入

dependencies {
 implementation('com.stalary:easy-doc:${version}')	
}

• maven
• gradle

• 网关配置
• 服务配置

规则介绍

特性更新文档

• Issues
• Email: stalary@163.com

• Pull Request

• 子项目路径获取错误,参考https://blog.csdn.net/Jane0908007/article/details/106427557