top.bayberry.core.tools

类 ApiDoc

java.lang.Object

top.bayberry.core.tools.ApiDoc

public class ApiDoc
extends Object

api文档生成器 https://swagger.io/

          ┌─┐       ┌─┐
       ┌──┘ ┴───────┘ ┴──┐
       │                 │
       │       ───       │
       │  ─┬┘       └┬─  │
       │                 │
       │       ─┴─       │
       │                 │
       └───┐         ┌───┘
           │         │
           │         │
           │         │
           │         └──────────────┐
           │                        │
           │                        ├─┐
           │      author:lelouch    ┌─┘
           │                        │
           └─┐  ┐  ┌───────┬──┐  ┌──┘
             │ ─┤ ─┤       │ ─┤ ─┤
             └──┴──┘       └──┴──┘
                 神兽保佑
                 代码无BUG!
 

作者:

lelouch

构造器概要

构造器

构造器和说明
ApiDoc(String name, String version, String baseurl) Instantiates a new Api doc.

方法概要

限定符和类型	方法和说明
String	generateDoc(List<Class> portclassList) Generate doc string.
String	getBaseurl() Gets baseurl.
String	getClassApi_action() Gets class api action.
String	getClassApi_param_className() Gets class api param class name.
String	getClassApi_param_ignore() Gets class api param ignore.
String	getCss() Gets css.
String	getCsslib() Gets csslib.
String	getFavicon() Gets favicon.
String	getJs() Gets js.
String	getJslib() Gets jslib.
String	getTitle() Gets title.
void	setClassApi_action(String classApi_action) Sets class api action.
void	setClassApi_param_className(String classApi_param_className) Sets class api param class name.
void	setClassApi_param_ignore(String classApi_param_ignore) Sets class api param ignore.
void	setCss(String css) Sets css.
void	setCsslib(String csslib) Sets csslib.
void	setFavicon(String favicon) Sets favicon.
void	setJs(String js) Sets js.
void	setJslib(String jslib) Sets jslib.
void	setTitle(String title) Sets title.

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

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

构造器详细资料

ApiDoc

public ApiDoc(String name,
              String version,
              String baseurl)

Instantiates a new Api doc.

参数:

name - 名称

version - 版本号

baseurl - 网站根目录

方法详细资料

getCsslib

public String getCsslib()

Gets csslib.

返回:

the csslib

setCsslib

public void setCsslib(String csslib)

Sets csslib.

参数:

csslib - the csslib

getCss

public String getCss()

Gets css.

返回:

the css

setCss

public void setCss(String css)

Sets css.

参数:

css - the css

getJslib

public String getJslib()

Gets jslib.

返回:

the jslib

setJslib

public void setJslib(String jslib)

Sets jslib.

参数:

jslib - the jslib

getJs

public String getJs()

Gets js.

返回:

the js

setJs

public void setJs(String js)

Sets js.

参数:

js - the js

getClassApi_action

public String getClassApi_action()

Gets class api action.

返回:

the class api action

setClassApi_action

public void setClassApi_action(String classApi_action)

Sets class api action.

参数:

classApi_action - the class api action

getClassApi_param_className

public String getClassApi_param_className()

Gets class api param class name.

返回:

the class api param class name

setClassApi_param_className

public void setClassApi_param_className(String classApi_param_className)

Sets class api param class name.

参数:

classApi_param_className - the class api param class name

getClassApi_param_ignore

public String getClassApi_param_ignore()

Gets class api param ignore.

返回:

the class api param ignore

setClassApi_param_ignore

public void setClassApi_param_ignore(String classApi_param_ignore)

Sets class api param ignore.

参数:

classApi_param_ignore - the class api param ignore

getFavicon

public String getFavicon()

Gets favicon.

返回:

the favicon

setFavicon

public void setFavicon(String favicon)

Sets favicon.

参数:

favicon - the favicon

getBaseurl

public String getBaseurl()

Gets baseurl.

返回:

the baseurl

getTitle

public String getTitle()

Gets title.

返回:

the title

setTitle

public void setTitle(String title)

Sets title.

参数:

title - the title

generateDoc

public String generateDoc(List<Class> portclassList)

Generate doc string.

参数:

portclassList - the portclass list

返回:

string