apidoc自动生成插件

apidoc-maven-plugin是一个接口文档自动生成插件,其核心逻辑就是通过接口解析模块apidoc-core来生成第三方接口文档处理工具apidoc能够识别的接口描述文件。该插件主要目的是提供一种简单、方便的接口文档生成方式,不用开发人员耗费过多精力在接口文档上面,你只需要按照javadoc规范把注释写好就行,其他的就交给工具来完成吧。另外也可以结合自动化处理脚本来实现接口文档的自动管理。


在工程中加入插件依赖

<plugin>

    <groupId>com.arsframework</groupId>

    <artifactId>apidoc-maven-plugin</artifactId>

    <version>1.3.11</version>

</plugin>

插件可通过Maven命令mvn apidoc:build运行,或者通过IDEA运行插件,默认会在项目/模块根目录下生成一个名字叫“项目/模块名称.apidoc”的接口描述文件,然后通过apidoc命令生成接口文档。


插件提供了一些参数来控制插件默认行为:

displayDate是否显示接口日期,默认为false。如果参数值为true,插件将按照接口方法、接口类的顺序依次解析@date注释,直到获取到有效的参数值,没有则不显示。

displayAuthor : 是否显示接口作者,默认为false。如果参数值为true,插件将按照接口方法、接口类的顺序依次解析@author注释,直到获取到有效的参数值,没有则不显示。

enableSampleRequest 是否启用接口请求,默认为false。如果参数值为true,接口文档将展示接口请求表单,否则在将接口文档中插入@apiSampleRequest off标记来关闭该功能,该参数需要与apidoc.json里面的sampleUrl参数配合使用(参考apidoc)。

includeGroupIdentities 接口文档所包含的Maven groupId列表,多个值之间使用","号隔开,默认包含当前项目的Group Identity。插件将根据该配置下载依赖包源码,并从这些源码中去解析接口文档信息,其中接口参数的解析与否也与此参数有关。

output 接口文档输出文件,默认为${project.basedir}/${project.name}.apidoc。

enableResponseExample 是否启用响应参数示例,默认为true。也可以通过在参数注视中加入@example来设置参数示例。

enableSnakeUnderlineConversion 是否启动将参数格式由驼峰转为下划线,默认false。如果参数已使用com.arsframework.spring.web.utils.param.Rename、com.fasterxml.jackson.annotation.JsonProperty、com.fasterxml.jackson.databind.annotation.JsonNaming注解,则忽略该参数。

analyserFactoryClass 设置自定义接口解析对象工厂类,通过该参数可覆盖系统默认处理逻辑。接口解析对象工厂接口为com.arsframework.apidoc.core.MethodAnalyser.Factory。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,542评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,822评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,912评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,449评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,500评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,370评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,193评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,074评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,505评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,722评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,841评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,569评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,168评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,783评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,918评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,962评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,781评论 2 354

推荐阅读更多精彩内容