org.noear.solon.docs

Class DocDocket

java.lang.Object

org.noear.solon.docs.DocDocket

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DocDocketProperties

public class DocDocket
extends Object
implements Serializable

文档摘要

Since:

2.2

Author:

noear

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocDocket()

Method Summary

Modifier and Type	Method and Description
List<ApiResource>	apis() 接口资源
DocDocket	apis(ApiResource apiResource) 配置接口资源
DocDocket	apis(String basePackage) 配置接口资源
String	basePath() 基础路径
DocDocket	basePath(String basePath) 配置基础路径
Map<String,String>	basicAuth() 基础鉴权（格式：admin#123456,user#654321,张三#abc）
DocDocket	basicAuth(BasicAuth basicAuth) 配置基础鉴权
DocDocket	basicAuth(String username, String password) 配置基础鉴权
DocDocket	enable(boolean enable) 配置是否启用
ApiExternalDocs	externalDocs() 外部文档
DocDocket	externalDocs(ApiExternalDocs externalDocs) 配置外部文档
DocDocket	externalDocs(String description, String url) 配置外部文档
Set<Object>	globalParams() 全局参数
DocDocket	globalParams(Collection<Object> globalParams) 配置全局参数
DocDocket	globalParams(Object param) 配置全局参数
Map<Integer,String>	globalResponseCodes() 全局响应代码描述（401,403...）
DocDocket	globalResponseCodes(Map<Integer,String> globalResponseCodes) 配置全局响应代码描述（401,403...）
boolean	globalResponseInData() 全局响应到data下面
DocDocket	globalResponseInData(boolean globalResponseInData) 配置全局响应到data下面
Class<?>	globalResult() 全局结果类
DocDocket	globalResult(Class<?> clz) 配置全局结果类
String	groupName() 分组名字
DocDocket	groupName(String groupName) 配置分组名字
String	host() 主机
DocDocket	host(String host) 配置主机
ApiInfo	info() 接口信息
DocDocket	info(ApiInfo info) 配置接口信息
boolean	isEnable() 是否启用
List<ApiScheme>	schemes() 协议架构（http, https）
DocDocket	schemes(String... schemes) 配置协议架构（http, https）
Map<String,Object>	securityExtensions() 安全扩展
DocDocket	securityExtensions(Map<String,Object> securityExtensions) 配置安全扩展
DocDocket	securityExtensions(String name, Object value) 配置安全扩展
org.noear.solon.core.serialize.Serializer<String>	serializer() 序列化
void	serializer(org.noear.solon.core.serialize.Serializer<String> serializer) 配置序列化
DocUpstream	upstream() 获取上游
DocDocket	upstream(DocUpstream upstream) 配置上游
DocDocket	upstream(String target, String contextPath, String path) 配置上游
Map<String,Object>	vendorExtensions() 供应商扩展
DocDocket	vendorExtensions(List<ApiVendorExtension> extensions) 配置供应商扩展
DocDocket	vendorExtensions(Map<String,Object> vendorExtensions) 配置供应商扩展
DocDocket	vendorExtensions(String name, Object value) 配置供应商扩展
String	version() 版本号
DocDocket	version(String version) 配置版本号

Methods inherited from class java.lang.Object

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

Constructor Detail

DocDocket

public DocDocket()

Method Detail

isEnable

public boolean isEnable()

是否启用

enable

public DocDocket enable(boolean enable)

配置是否启用

version

public String version()

版本号

version

public DocDocket version(String version)

配置版本号

host

public String host()

主机

host

public DocDocket host(String host)

配置主机

schemes

public List<ApiScheme> schemes()

协议架构（http, https）

schemes

public DocDocket schemes(String... schemes)

配置协议架构（http, https）

groupName

public String groupName()

分组名字

groupName

public DocDocket groupName(String groupName)

配置分组名字

basePath

public String basePath()

基础路径

basePath

public DocDocket basePath(String basePath)

配置基础路径

basicAuth

public Map<String,String> basicAuth()

基础鉴权（格式：admin#123456,user#654321,张三#abc）

basicAuth

public DocDocket basicAuth(String username,
                           String password)

配置基础鉴权

basicAuth

public DocDocket basicAuth(BasicAuth basicAuth)

配置基础鉴权

apis

public List<ApiResource> apis()

接口资源

apis

public DocDocket apis(String basePackage)

配置接口资源

apis

public DocDocket apis(ApiResource apiResource)

配置接口资源

info

public ApiInfo info()

接口信息

info

public DocDocket info(ApiInfo info)

配置接口信息

upstream

public DocUpstream upstream()

获取上游

upstream

public DocDocket upstream(DocUpstream upstream)

配置上游

upstream

public DocDocket upstream(String target,
                          String contextPath,
                          String path)

配置上游

globalResponseInData

public boolean globalResponseInData()

全局响应到data下面

globalResponseInData

public DocDocket globalResponseInData(boolean globalResponseInData)

配置全局响应到data下面

globalResponseCodes

public Map<Integer,String> globalResponseCodes()

全局响应代码描述（401,403...）

globalResponseCodes

public DocDocket globalResponseCodes(Map<Integer,String> globalResponseCodes)

配置全局响应代码描述（401,403...）

globalResult

public Class<?> globalResult()

全局结果类

globalResult

public DocDocket globalResult(Class<?> clz)

配置全局结果类

globalParams

public Set<Object> globalParams()

全局参数

globalParams

public DocDocket globalParams(Collection<Object> globalParams)

配置全局参数

globalParams

public DocDocket globalParams(Object param)

配置全局参数

externalDocs

public ApiExternalDocs externalDocs()

外部文档

externalDocs

public DocDocket externalDocs(ApiExternalDocs externalDocs)

配置外部文档

externalDocs

public DocDocket externalDocs(String description,
                              String url)

配置外部文档

vendorExtensions

public Map<String,Object> vendorExtensions()

供应商扩展

vendorExtensions

public DocDocket vendorExtensions(Map<String,Object> vendorExtensions)

配置供应商扩展

vendorExtensions

public DocDocket vendorExtensions(String name,
                                  Object value)

配置供应商扩展

vendorExtensions

public DocDocket vendorExtensions(List<ApiVendorExtension> extensions)

配置供应商扩展

securityExtensions

public Map<String,Object> securityExtensions()

安全扩展

securityExtensions

public DocDocket securityExtensions(Map<String,Object> securityExtensions)

配置安全扩展

securityExtensions

public DocDocket securityExtensions(String name,
                                    Object value)

配置安全扩展

serializer

public org.noear.solon.core.serialize.Serializer<String> serializer()

序列化

serializer

public void serializer(org.noear.solon.core.serialize.Serializer<String> serializer)

配置序列化