# javadoc4openapi-maven-plugin

**Repository Path**: chunanyong/javadoc4openapi-maven-plugin

## Basic Information

- **Project Name**: javadoc4openapi-maven-plugin
- **Description**: javadoc4openapi的maven插件,编译时自动生成openapi文档
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 0
- **Created**: 2020-08-15
- **Last Updated**: 2022-05-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 介绍
[javadoc4openapi](https://gitee.com/chunanyong/javadoc4openapi) 使用java注释代替swagger注解,生成openapi(swagger3)文档,代码零侵入.

javadoc4openapi-maven-plugin是其maven插件,项目编译时在resources下生成javadoc4openapi.yaml文档文件.

  目前支持SpringMVC/SpringBoot

## 使用条件
依赖源码,项目在编译时需要打源码包,Maven配置如下

```
<!-- Source -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>3.2.1</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>jar-no-fork</goal>
            </goals>
        </execution>
    </executions>
</plugin>
```

## 如何使用
目前还没有上传到Maven仓库,需要手动在本地install一下再引用.

Maven插件配置如下


```

            <plugin>
                <groupId>org.springrain</groupId>
                <artifactId>javadoc4openapi-maven-plugin</artifactId>
                <version>0.0.1</version>
                <configuration>
                    <includes>
                        <!--需要加载分析的maven依赖源码包,本项目的groupId默认添加-->
                        <!--可以添加groupId或者groupId:artifactId-->
                        <!--
                        <include>org.springrain</include>
                        -->
                    </includes>
                </configuration>
                <executions>
                    <execution>
                        <!--如果不需要在执行编译时启动，则将phase注释掉-->
                        <phase>compile</phase>
                        <goals>
                            <goal>openapi</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
```

## 头条号  
博客 [https://www.jiagou.com](https://www.jiagou.com)  
![架构头条号](https://images.gitee.com/uploads/images/2020/0920/213826_38708bb4_686.jpeg "toutiao_300x300.jpg")