cn.schoolwow.quickapi

类 QuickAPI

java.lang.Object

cn.schoolwow.quickapi.QuickAPI

public class QuickAPI
extends Object

方法概要

限定符和类型	方法和说明
APIMicro	apiMicro() 添加一个微服务
QuickAPI	apiMicro(APIMicroService... apiMicroServices) 添加一个微服务
QuickAPI	classPath(URL classPathURL) Java类路径
QuickAPI	controller(String packageName) 扫描controller层
QuickAPI	controllerClass(String className) 扫描controller层
QuickAPI	description(String description) 设置文档描述
QuickAPI	directory(String directory) 文档生成目录
QuickAPI	filter(java.util.function.Predicate<String> predicate) 扫描类过滤接口
QuickAPI	generate() 生成接口文档
QuickAPI	ignoreClass(String ignoreClassName) 忽略类
QuickAPI	ignorePackageName(String ignorePackageName) 忽略包名
QuickAPI	lib(String libDirectory) 指定类库位置
static QuickAPI	newInstance()
QuickAPI	plugin(QuickAPIPlugin... quickAPIPlugins) 生成接口文档
QuickAPI	pom(String pomFilePath) 扫描pom.xml获取相关依赖
QuickAPI	prefix(String prefix) 接口路径前缀
QuickAPI	sourcePath(String sourcePath) Java源代码路径
QuickAPI	title(String title) 指定文档标题
void	upload() 上传到默认服务器
void	upload(String host) 上传到服务器
void	upload(String host, Proxy proxy) 上传到服务器
QuickAPI	url(String url) 文档路径地址

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

newInstance

public static QuickAPI newInstance()

controller

public QuickAPI controller(String packageName)

扫描controller层

参数:

packageName - 扫描Controller包

controllerClass

public QuickAPI controllerClass(String className)

扫描controller层

参数:

className - 扫描单个Controller类

prefix

public QuickAPI prefix(String prefix)

接口路径前缀

参数:

prefix - 接口路径前缀(context-path)

sourcePath

public QuickAPI sourcePath(String sourcePath)

Java源代码路径

参数:

sourcePath - 指定java源代码所在目录

classPath

public QuickAPI classPath(URL classPathURL)

Java类路径

参数:

classPathURL - 指定java类文件

pom

public QuickAPI pom(String pomFilePath)

扫描pom.xml获取相关依赖

参数:

pomFilePath - pom.xml路径

lib

public QuickAPI lib(String libDirectory)
             throws IOException

指定类库位置

参数:

libDirectory - lib库位置

抛出:

IOException

ignorePackageName

public QuickAPI ignorePackageName(String ignorePackageName)

忽略包名

参数:

ignorePackageName - 要忽略的包名

ignoreClass

public QuickAPI ignoreClass(String ignoreClassName)

忽略类

参数:

ignoreClassName - 要忽略的类名

filter

public QuickAPI filter(java.util.function.Predicate<String> predicate)

扫描类过滤接口

参数:

predicate - 函数式接口 参数为类名

title

public QuickAPI title(String title)

指定文档标题

参数:

title - 指定接口文档标题(唯一标识)

description

public QuickAPI description(String description)

设置文档描述

参数:

description - 文档描述

url

public QuickAPI url(String url)

文档路径地址

参数:

url - 指定文档访问路径

directory

public QuickAPI directory(String directory)

文档生成目录

参数:

directory - 指定文档生成目录

apiMicro

public APIMicro apiMicro()

添加一个微服务

apiMicro

public QuickAPI apiMicro(APIMicroService... apiMicroServices)

添加一个微服务

参数:

apiMicroServices - 微服务列表

generate

public QuickAPI generate()
                  throws IOException

生成接口文档

抛出:

IOException

plugin

public QuickAPI plugin(QuickAPIPlugin... quickAPIPlugins)
                throws IOException

生成接口文档

抛出:

IOException

upload

public void upload()

上传到默认服务器

upload

public void upload(String host)

上传到服务器

参数:

host - 服务器地址

upload

public void upload(String host,
                   Proxy proxy)

上传到服务器

参数:

host - 服务器地址

proxy - http代理