javadoc4openapi-maven-plugin

文档工具
授权协议 Apache
开发语言 Java
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 国产
投 递 者 翁良弼
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

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>

 

  • 一、发现问题 建立maven项目后,pom.xml在显示红叉,鼠标放上去,显示Execution default-testResources of goal org.apache.maven.plugins:maven-resources-plugin:2.4.3错误。 二、原因分析 缺少maven-resources-plugin-2.4.3.jar或该文件下载不正确,可到repository\

  • 错误环境:maven-compiler-plugin 插件版本信息错误提示的解决方法 使用maven-compiler-plugin 时  POM文件如下: <plugins>        <plugin>           <artifactId>maven-compiler-plugin</artifactId>          <configuration>              

  •   博客分类:  JDK1.5+ JAVA   Java 8 配置Maven-javadoc-plugin 转自:http://codepub.cn/2016/10/18/Java-8-configure-maven-java-doc-plugin/   在升级JDK至1.8之后,使用Maven-javadoc-plugin插件打包报错,[ERROR] Failed to execute goal

  • 字面意思就是没有指定版本信息 ,警告问题:程序可以运行 增加一行  <version>2.3.2</version>  用来指定版本信息    <build>         <plugins>             <plugin>                 <groupId>org.apache.maven.plugins</groupId>                 <arti

  • 解决org.apache,maven.plugins:maven-jar-plugin:pom:2.4 在使用Maven时出现以下错误: Failure to transfer org.apache.maven.plugins:maven-jar-plugin:pom:2.4 from https://repo.maven.apache.org/maven2 was cached in the l

  • 正常的main函数程序,我们直接package生成的jar包无法直接运行,因为没有再/META-INF/MANIFEST.MF中指定主类。 1.指定主类有很多方法,这里介绍下最简单的使用maven-jar-plugin插件的方法。 只需要加一条mainClass的配置,指定主类名即可; 这样不出意外可以运行。 2.如果我们的项目有外部依赖,即定义了dependency,那么默认不会把依赖打入jar

  • 错误: 当使用Maven的工具命令出现(错误): error:Plugin org.apache.maven.plugins:maven-clean-plugin:2.5 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.apache.maven.plu

 相关资料
  • Apache Maven 是一个软件项目管理和理解工具。 基于项目对象模型(POM)的概念,Maven可以从一个中心信息管理项目的构建,报告和文档。

  • 我正在将一个现有的项目(遗留)移到Maven。其结构如下: 我打算有两个不同的概况:生产和开发。在production profile中,/warmodule/src/main/resources/prod/index.jsp应该组装到views/war目录中。在开发概要文件中,/warmodule/src/main/resources/dev/index.jsp应该复制到views/war目录中

  • 我有一个项目,它使用maven-assembly-plugin打包了几个(可执行的jar)程序集--基本上相同的代码,但针对不同的客户机使用了不同的数据集。 我需要在可执行jar中使用spring,由于spring中的文件命名,我需要使用maven-shade-plugin创建jar。这工作很好,我可以创建可执行的jar,但我不能确定如何将我的其他文件组装到这个新的shaded jar,因为sha

  • Sphinx简单来说,是一个文档生成工具,用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无须亲自处理文本的格式, 程序会自动根据源文件里的设置产生格式, 以及自动生成章节链接等工作。 和 DocBook一样,Sphinx可以看做是一个把文本格式处理和文字编辑分开的工具。举个例子来说吧,大家一定都曾有过上学时用Word痛苦地修改论文 的

  • Maven shade plugin 为 Maven 提供了 Jar 打包的神器,包括将所依赖的 jar 包都打包到一起。

  • 前言 该生成器是基于mybatis-plus的基础上根据个人在实际生产中所遇到过的各种设计而进行思考扩展的。为了提供更好地扩展性,使用者只需提供自定义的模板即可生成对应的文件,也可使用默认模板。目前模板语言只支持freemarker,因为作为一个生成工具个人认为无需考虑性能与使用哪种模板语言上的问题也没有对模板这方面进行深究,个人对freemarker也只是略懂(遇到不懂的表达式自己也是百度一下,