pro.haichuang.framework.base.config.swagger.factory

类 SwaggerFactory

java.lang.Object

pro.haichuang.framework.base.config.swagger.factory.SwaggerFactory

public final class SwaggerFactory
extends Object

swagger工厂类

该类为 [Swagger] 工厂类, 主要用于根据 SwaggerInfo 创建 Docket 对象

该类指定了部分默认参数, 如需自定义在参数 SwaggerInfo 中进行赋值相关属性即可

注意: 请求地址中带有 [common] 字段时 SecurityContext 上下文将不生效

从以下版本开始:

1.1.0.211021

作者:

JiYinchuan

另请参阅:

SwaggerInfo

字段概要

字段

限定符和类型	字段和说明
static springfox.documentation.service.Contact	DEFAULT_CONTACT 默认作者信息
static String	DEFAULT_DESCRIPTION 默认描述
static String	DEFAULT_GROUP_NAME 默认分组名
static String	DEFAULT_TERMS_OF_SERVICE_URL 默认服务条款URL
static String	DEFAULT_TITLE 默认标题
static String	DEFAULT_VERSION 默认版本号
static Pattern	IGNORE_PATTERN 忽略权限的正则表达式 主要用于接口文档中默认对匹配的路径不加上请求头, 方便操作

构造器概要

构造器

构造器和说明
SwaggerFactory()

方法概要

限定符和类型	方法和说明
static springfox.documentation.spring.web.plugins.Docket	createRestApi(SwaggerInfo infoDTO) 初始化API文档

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

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

字段详细资料

DEFAULT_GROUP_NAME

public static final String DEFAULT_GROUP_NAME

默认分组名

另请参阅:

常量字段值

DEFAULT_TITLE

public static final String DEFAULT_TITLE

默认标题

另请参阅:

常量字段值

DEFAULT_DESCRIPTION

public static final String DEFAULT_DESCRIPTION

默认描述

另请参阅:

常量字段值

DEFAULT_TERMS_OF_SERVICE_URL

public static final String DEFAULT_TERMS_OF_SERVICE_URL

默认服务条款URL

另请参阅:

常量字段值

DEFAULT_CONTACT

public static final springfox.documentation.service.Contact DEFAULT_CONTACT

默认作者信息

DEFAULT_VERSION

public static final String DEFAULT_VERSION

默认版本号

另请参阅:

常量字段值

IGNORE_PATTERN

public static final Pattern IGNORE_PATTERN

忽略权限的正则表达式 主要用于接口文档中默认对匹配的路径不加上请求头, 方便操作

构造器详细资料

SwaggerFactory

public SwaggerFactory()

方法详细资料

createRestApi

public static springfox.documentation.spring.web.plugins.Docket createRestApi(SwaggerInfo infoDTO)

初始化API文档

参数:

infoDTO - Swagger信息

返回:

API文档

从以下版本开始:

1.1.0.211021