美文网首页
无嵌入api生成工具

无嵌入api生成工具

作者: 小李_a98e | 来源:发表于2019-03-26 12:04 被阅读0次
<dependency>
            <groupId>com.github.apiggs</groupId>
            <artifactId>apiggs</artifactId>
            <version>1.6</version>
</dependency>

编码

Environment env = new Environment()
    .id("example")
    .title("示例接口文档")
    .description("示例接口文档,使用默认模板");
new Apiggs(env).lookup().build();

参数说明

id 项目id,生成id.html等文件
title 文档标题
description 文档描述
production 输出文件夹,默认为apiggs
out 输出目录,默认为target
source 源码目录,默认读取当前项目的src/main/java
dependency 源码依赖的代码目录,以逗号隔开
jar 源码依赖的jar包目录,以逗号隔开
ignore 忽略某些类型,如UserDTO
version 文档版本号
css 设置html样式表

maven 插件

<plugin>
    <groupId>com.github.apiggs</groupId>
    <artifactId>apiggs-maven-plugin</artifactId>
    <version>1.6</version>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>apiggs</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <!-- options in there -->
    </configuration>
</plugin>

tip

执行 mvn compile  需要clean install 时 请把插件注释掉 因为有冲突

相关文章

  • 无嵌入api生成工具

    编码 参数说明 maven 插件 tip

  • 微信支付密钥

    一. 支付p12证书 生成API证书生成API证书 下载证书工具生成KEY 如果没有设置操作密码先设置操作密码操作...

  • swagger

    介绍 号称世界上最流行的APi框架; restful Api文档在线自动生成工具 ->APi文档与Api定义同步更...

  • API 文档生成工具

    转自:https://my.oschina.net/u/811578/blog/657166 摘要: 随着API的...

  • Api文档自动生成工具

    java开发,根据代码自动生成api接口文档工具,支持RESTful风格,今天我们来学一下api-doc的生成 预...

  • Java文档自动生成

    java-api-doc 励志做java届最好的文档生成工具,自动解析代码生成api接口文档,前后台分离开发的福音...

  • Doxygen文档生成工具教程

    Doxygen是API文档生成工具,可以根据代码注释生成文档的工具。支持HTML、CHM、PDF等格式。主要支持C...

  • Swagger2知识点

    Swagger 号称世界上最流行的Apiece框架 RestFul Api 文档在线自动生成工具=>Api文档与A...

  • api文档自动生成工具

    api-doc java开发,根据代码自动生成api接口文档工具,支持RESTful风格 预览 在线预览地址 ht...

  • 十、springboot集成swagger2

    什么是swagger2. 就是一个自动生成api文档的工具。

网友评论

      本文标题:无嵌入api生成工具

      本文链接:https://www.haomeiwen.com/subject/cfyjqqtx.html