Evalon4JJava 接口文檔生成工具

Evalon4J 是一個(gè) Java 接口文檔生成工具，直接通過(guò)命令行使用，支持Spring-MVC，JAX-RS，Swagger 2.0 等多種框架注解。同時(shí)它是付費(fèi)產(chǎn)品 RabiAPI 使用的底層框架，通過(guò)靜態(tài)分析源代碼，直接生成相對(duì)應(yīng)的接口文檔。

和大多數(shù)開(kāi)源框架不同，Evalon4J 使用 JavaParser 直接分析源代碼，不需要使用任何 Gradle 或者 Maven 插件，所以使用者不會(huì)遇到任何和插件有關(guān)的煩人問(wèn)題，更不會(huì)有任何版本沖突。

功能特色

• 純命令行工具，與項(xiàng)目本身零耦合，使用方便
• 純靜態(tài)分析，無(wú)需事先編譯，構(gòu)建項(xiàng)目，極速生成
• 支持Java泛型，遞歸，繼承等寫(xiě)法
• 支持不同框架的混合使用
• 完全支持標(biāo)準(zhǔn)Javadoc注釋
• 完全支持枚舉類(lèi)型

參數(shù)說(shuō)明

• -p，指定需要生成文檔的Java項(xiàng)目根目錄，文檔默認(rèn)會(huì)生成在項(xiàng)目文件夾內(nèi)
• -o，指定導(dǎo)出的文檔格式，目前已支持 markdown
• -c，指定 evalon4j.json 配置文件位置，通常用不著

配置文件

你可以在項(xiàng)目根目錄下提供一份 evalon4j.json 配置文件，運(yùn)行時(shí)會(huì)自動(dòng)讀取。

{
  "name": "", // 項(xiàng)目名稱(chēng)
  
  "author": "whitecoms0s_", // 項(xiàng)目維護(hù)者
  
  "version": "1.0", // 文檔版本，默認(rèn)為1.0
  
  "includedServices": [], // 需要導(dǎo)出的服務(wù)名稱(chēng)或全名，白名單
  
  "excludedServices": [], // 需要過(guò)濾的服務(wù)名稱(chēng)或全名，黑名單
  
  "dependencies": [], // 項(xiàng)目依賴(lài)的源碼包路徑列表，(規(guī)劃中)
  
  "onlyHttpApi": false, // 僅導(dǎo)出HTTP接口
  
  "onlyJavaApi": false, // 僅導(dǎo)出RPC接口
  
  "locale": "zh", // en 或 zh，會(huì)覆蓋系統(tǒng)語(yǔ)言設(shè)置，沒(méi)有該字段默認(rèn)使用系統(tǒng)語(yǔ)言設(shè)置
}