# api-generator-maven-plugin

**Repository Path**: ysar/api-generator-maven-plugin

## Basic Information

- **Project Name**: api-generator-maven-plugin
- **Description**: api-generator-maven-plugin：一个api生成功工具，自动同步javaDoc接口文档到私有化部署的Yapi中


- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-12-02
- **Last Updated**: 2023-02-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### install
```xml
<plugin>
    <groupId>com.ysarsw</groupId>
    <artifactId>api-generator-maven-plugin</artifactId>
    <version>1.0.0</version>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>api-generator</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <!-- options in there -->
        <serverUrl></serverUrl>
        <projectToken></projectToken>
    </configuration>
</plugin>
```

### options

1. serverUrl: 私有化部署yApi的域名
1. projectToken: 要导入的项目token

### 执行
配置好上面的maven插件之后，切换到项目文件夹，执行maven命令：
`mvn api-generator:api-generator`