The easy-doc-core from easy-doc

easy-doc-core's Introduction

项目介绍

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

使用方式

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

网关模式效果图

服务模式效果图

接口详情效果图

对象列表效果图

全局参数效果图

设计思路

设计思路文档

引入依赖方法

远程仓库地址
使用maven引入

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

使用gradle引入

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

打包插件引入

maven
gradle

配置方式

注释书写规则

规则介绍

版本特性

特性更新文档

Bug/Feature 提交

Issues
Email: [email protected]

参与贡献

Pull Request

常见问题

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

easy-doc-core's People

Contributors

Stargazers

Watchers

easy-doc-core's Issues

项目生成报错

您好，我使用了您的工具，但是目前报错，具体情况如下：

项目为Spring boot，使用maven引入，代码如下：

com.stalary easy-doc 1.3.5

yml配置如下：
com:
stalary:
easydoc:
name: easydoc demo # 项目名称
contact: [email protected] # 项目联系人
description: easydoc测试项目 # 项目描述
path: org.yuxin # 解析的包路径(包括data和controller的包)
open: true # 是否开启文档功能
source: true # 是否读取源码,false则为读取resources中的easydoc.txt

项目目录结构如下：