授权协议: Apache
开发语言: Java
操作系统: 跨平台
收录时间: 2020-09-14
提 交 者: 光石头

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>

 

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

javadoc4openapi-maven-plugin 的相关资讯

还没有任何资讯

javadoc4openapi-maven-plugin 的相关博客

maven之plugin

发布 clean deploy 设置pom <distributionManagement> <repository> <id>user-release</id> <name>user release resp</name> ...

使用Maven打包你的应用——maven-jar-plugin & maven-assembly-plugin & maven-shade-plugin

原文链接:https://www.dubby.cn/detail.html?id=9091 介绍maven-jar-plugin,maven-assembly-plugin和maven-shade-plugin的使...

maven错误:Failure to find maven-plugins:maven-cobertura-plugin:plugin:1.3

今天用maven构建项目时出现个问题,编译打包时,提示如下 Failure to find maven-plugins:maven-cobertura-plugin:plugin:1....

Jetty Maven Plugin

①Maven settings.xml文件 <pluginGroups>   <pluginGroup>org.mortbay.jetty</pluginGroup> </pluginGroups> ②Maven 项目的p...

maven-archetype-plugin

如果是Maven3,直接在命令行执行 mvn archetype : generate 如果是Maven2,运行如下命令: mvn org.apache.maven.plugins:mav...

maven jetty plugin

maven jetty plugin

maven-shade-plugin

最近,用规则引擎(drools)的封装了一个jar包,给别人使用。用的是maven-assembly-plugin打的包,可以把多个jar包里的class 给...

javadoc4openapi-maven-plugin 的相关问答

还没有任何问答,马上提问

评论 (0)

加载中
更多评论
0 评论
3 收藏
分享
在线直播报名
返回顶部
顶部