Evalon4J - The Ultimate Java API Documentation Generator

Introduction

Evalon4J is a framework developed for Mac App RabiAPI, you can directly use it as a command tool for generating java api documentation.

I have used SpringFox before, it's needs a lot of configurations and I think markdown is enough for me, so I developed this tool.

If you like it !!!PLEASE STAR THIS PROJECT!!!

How To Use

Evalon4J is a command line tool and very easy to use.

Download the zip file and extract it.
Get into the bin directory from terminal.
Execute ./evalon4j -p {{Your Java Project Path}} -o markdown
The evalon4j dir will be generated under your project root path

Parameters

-p specify the java project path, the output will be there and named as evalon4j
-o specify the output format，now support: markdown, swagger, openapi
-c specify a evalon4j.json configuration file, or just put it under your project root

Configuration

You can also put a evalon4j.json file under your module or project root (if not multiple module project), or using -c to specify one.

{
  "name": "", // Project Name
  
  "author": "whitecoms0s_", // Project Author
  
  "version": "1.0", // API Version, Default is 1.0
  
  "includedServices": [], // Included services, service name or service qualified name 
  
  "excludedServices": [], // Excluded services, service name or service qualified name
  
  "dependencies": [], // Source jars path, (developing)
  
  "onlyHttpApi": false, // Only Export HTTP API
  
  "onlyJavaApi": false, // Only Export Java API (interface)
  
  "locale": "zh", // Set Export Locale，en or zh，If not set, using system locale
}

Road Map

Export documentation as a static website
Support ApidocJS Framework

Features

Simple command line tool, no massive dependencies, I swear.
Pure Static Analysis, no need to build or compile your project, no waste of time.
Support Java generic, recursive, extension
Complete support javadoc
Complete support java enumeration

Supported Frameworks

Pure Java interface and javadoc, used for RPC Service
Spring MVC
JAX-RS
Swagger 2.0 Annotations, like @ApiOperation
OpenAPI 3.0 Annotations
JSR303 Bean Validation Annotations

Supported Export Format

markdown (complete)
swagger 2.0 json file (developing)
openapi 3.0 json file (developing)

Contact Me

You can join the gitter chat group.

Or just open an issue.

RabiAPI/Evalon4J