# java-plugin-doc-generate

**Repository Path**: linlannet/java-plugin-doc-generate

## Basic Information

- **Project Name**: java-plugin-doc-generate
- **Description**: 接口文档生产插件，API文档生成插件，在各个应用工程中引用实现文档自动生成，基于smart-doc项目，合并简洁，保持java1.8编译，增加smart-doc.json和pom.xml示例，简单易用
- **Primary Language**: HTML
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 2
- **Created**: 2023-07-08
- **Last Updated**: 2026-07-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# java-plugin-doc-generate

[![License](https://img.shields.io/badge/license-Apache%202-green.svg)](https://www.apache.org/licenses/LICENSE-2.0)
![java version](https://img.shields.io/badge/JAVA-1.8-green.svg)
![gitee star](https://gitee.com/linlannet/java-plugin-doc-generate/badge/star.svg)


## 介绍
Linlan 接口文档自动化生成插件，按照规范要求进行文档注释编写即可，支持JAVA代码
保留JAVA1.8版本，基于smart-doc修改优化

[smart-doc](https://gitee.com/TongchengOpenSource/smart-doc)

doc-generate是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，doc-generate在业内率先提出基于JAVA泛型定义推导的理念，
完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， doc-generate就能帮你生成一个简易明了的Markdown、HTML5、Postman
Collection2.0+、OpenAPI 3.0+的文档。



## 版本历史

[CHANGELOG](./CHANGELOG.md)


## 生成及使用

```
//生成html
mvn -Dfile.encoding=UTF-8 doc-generate:html
//生成markdown
mvn -Dfile.encoding=UTF-8 doc-generate:markdown
//生成adoc
mvn -Dfile.encoding=UTF-8 doc-generate:adoc
//生成postman json数据
mvn -Dfile.encoding=UTF-8 doc-generate:postman
// 生成 Open Api 3.0+,Since doc-generate-maven-plugin 1.1.5
mvn -Dfile.encoding=UTF-8 doc-generate:openapi
// 生成文档推送到Torna平台
mvn -Dfile.encoding=UTF-8 doc-generate:torna-rest

// Apache Dubbo RPC文档
// Generate html
mvn -Dfile.encoding=UTF-8 doc-generate:rpc-html
// Generate markdown
mvn -Dfile.encoding=UTF-8 doc-generate:rpc-markdown
// Generate adoc
mvn -Dfile.encoding=UTF-8 doc-generate:rpc-adoc

// 生成dubbo接口文档推送到torna
mvn -Dfile.encoding=UTF-8 doc-generate:torna-rpc
```