A B C D E F G H I L M N O P R S T U V

A

ApiContact - Class in org.noear.solon.docs.models

接口联系信息

ApiContact() - Constructor for class org.noear.solon.docs.models.ApiContact

ApiEnum - Class in org.noear.solon.docs

接口枚举常量

ApiEnum() - Constructor for class org.noear.solon.docs.ApiEnum

ApiExternalDocs - Class in org.noear.solon.docs.models

接口扩展文档

ApiExternalDocs() - Constructor for class org.noear.solon.docs.models.ApiExternalDocs

ApiExternalDocs(String, String) - Constructor for class org.noear.solon.docs.models.ApiExternalDocs

ApiGroupResource - Class in org.noear.solon.docs.models

接口组资源

ApiGroupResource(String, String, String, String) - Constructor for class org.noear.solon.docs.models.ApiGroupResource

ApiInfo - Class in org.noear.solon.docs.models

接口信息

ApiInfo() - Constructor for class org.noear.solon.docs.models.ApiInfo

ApiLicense - Class in org.noear.solon.docs.models

接口许可证

ApiLicense() - Constructor for class org.noear.solon.docs.models.ApiLicense

ApiNoAuthorize - Annotation Type in io.swagger.solon.annotation

接口无需认证,生成文档不追加全局参数

ApiRes - Annotation Type in io.swagger.solon.annotation

接口返回参数.在httpCode=200中返回

ApiResource - Class in org.noear.solon.docs.models

接口资源信息

ApiResource() - Constructor for class org.noear.solon.docs.models.ApiResource

ApiResource(String) - Constructor for class org.noear.solon.docs.models.ApiResource

ApiResource(Predicate<Action>) - Constructor for class org.noear.solon.docs.models.ApiResource

ApiResProperty - Annotation Type in io.swagger.solon.annotation

接口返回参数

apis() - Method in class org.noear.solon.docs.DocDocket

接口资源

apis(String) - Method in class org.noear.solon.docs.DocDocket

配置接口资源

apis(ApiResource) - Method in class org.noear.solon.docs.DocDocket

配置接口资源

ApiScheme - Enum in org.noear.solon.docs.models

接口协议架构

ApiVendorExtension<T> - Interface in org.noear.solon.docs.models

接口供应商扩展

B

base64DecodeToStr(String) - Static method in class org.noear.solon.docs.util.BasicAuthUtil

base64EncodeToStr(String, String) - Static method in class org.noear.solon.docs.util.BasicAuthUtil

basePackage() - Method in class org.noear.solon.docs.models.ApiResource

basePackage(String) - Method in class org.noear.solon.docs.models.ApiResource

basePath() - Method in class org.noear.solon.docs.DocDocket

基础路径

basePath(String) - Method in class org.noear.solon.docs.DocDocket

配置基础路径

BasicAuth - Interface in org.noear.solon.docs

基础签权

basicAuth() - Method in class org.noear.solon.docs.DocDocket

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

basicAuth(String, String) - Method in class org.noear.solon.docs.DocDocket

配置基础鉴权

basicAuth(BasicAuth) - Method in class org.noear.solon.docs.DocDocket

配置基础鉴权

basicAuth(Context, DocDocket) - Static method in class org.noear.solon.docs.util.BasicAuthUtil

WWW-Authenticate 简单认证

BasicAuthUtil - Class in org.noear.solon.docs.util

BasicAuthUtil() - Constructor for class org.noear.solon.docs.util.BasicAuthUtil

C

CONSUMES_FILE - Static variable in class org.noear.solon.docs.ApiEnum

CONSUMES_FORM_DATA - Static variable in class org.noear.solon.docs.ApiEnum

CONSUMES_JSON - Static variable in class org.noear.solon.docs.ApiEnum

CONSUMES_URLENCODED - Static variable in class org.noear.solon.docs.ApiEnum

CONSUMES_XML - Static variable in class org.noear.solon.docs.ApiEnum

contact() - Method in class org.noear.solon.docs.models.ApiInfo

contact(ApiContact) - Method in class org.noear.solon.docs.models.ApiInfo

contact(String, String, String) - Method in class org.noear.solon.docs.models.ApiInfo

D

description() - Method in class org.noear.solon.docs.models.ApiExternalDocs

description() - Method in class org.noear.solon.docs.models.ApiInfo

description(String) - Method in class org.noear.solon.docs.models.ApiInfo

DiscoverLocator - Class in org.noear.solon.docs.integration

服务发现事件监听器

DiscoverLocator(AppContext, DiscoverProperties) - Constructor for class org.noear.solon.docs.integration.DiscoverLocator

DiscoverProperties - Class in org.noear.solon.docs.integration.properties

分布式发现配置属性

DiscoverProperties() - Constructor for class org.noear.solon.docs.integration.properties.DiscoverProperties

DocDocket - Class in org.noear.solon.docs

文档摘要

DocDocket() - Constructor for class org.noear.solon.docs.DocDocket

DocDocketProperties - Class in org.noear.solon.docs.integration.properties

文档摘要属性

DocDocketProperties() - Constructor for class org.noear.solon.docs.integration.properties.DocDocketProperties

DocException - Exception in org.noear.solon.docs.exception

文档异常

DocException(String) - Constructor for exception org.noear.solon.docs.exception.DocException

DocException(String, Throwable) - Constructor for exception org.noear.solon.docs.exception.DocException

DocsPlugin - Class in org.noear.solon.docs.integration

DocsPlugin() - Constructor for class org.noear.solon.docs.integration.DocsPlugin

DocsProperties - Class in org.noear.solon.docs.integration.properties

文档配置属性

DocsProperties() - Constructor for class org.noear.solon.docs.integration.properties.DocsProperties

DocType - Enum in org.noear.solon.docs

文档类型

DocUpstream - Class in org.noear.solon.docs

文档上游

DocUpstream() - Constructor for class org.noear.solon.docs.DocUpstream

DocUpstream(URI, String, String) - Constructor for class org.noear.solon.docs.DocUpstream

DOUBLE - Static variable in class org.noear.solon.docs.ApiEnum

E

email(String) - Method in class org.noear.solon.docs.models.ApiContact

email() - Method in class org.noear.solon.docs.models.ApiContact

enable(boolean) - Method in class org.noear.solon.docs.DocDocket

配置是否启用

externalDocs() - Method in class org.noear.solon.docs.DocDocket

外部文档

externalDocs(ApiExternalDocs) - Method in class org.noear.solon.docs.DocDocket

配置外部文档

externalDocs(String, String) - Method in class org.noear.solon.docs.DocDocket

配置外部文档

F

FILE - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_BINARY - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_BOOLEAN - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_BYTE - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_DATE - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_DATE_TIME - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_DOUBLE - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_FLOAT - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_INTEGER - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_LONG - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_PASSWORD - Static variable in class org.noear.solon.docs.ApiEnum

FORMAT_STRING - Static variable in class org.noear.solon.docs.ApiEnum

forValue(String) - Static method in enum org.noear.solon.docs.models.ApiScheme

G

getBasicAuth() - Method in class org.noear.solon.docs.integration.properties.DiscoverProperties

基础鉴权配置

getContextPath() - Method in class org.noear.solon.docs.DocUpstream

获取资源组上下文路径

getContextPath() - Method in class org.noear.solon.docs.models.ApiGroupResource

getContextPathPattern() - Method in class org.noear.solon.docs.integration.properties.DiscoverProperties

contextPath 构建模式

getDiscover() - Method in class org.noear.solon.docs.integration.properties.DocsProperties

发现配置

getExcludedServices() - Method in class org.noear.solon.docs.integration.properties.DiscoverProperties

排除服务

getId() - Method in class org.noear.solon.docs.integration.properties.DocDocketProperties

getIncludedServices() - Method in class org.noear.solon.docs.integration.properties.DiscoverProperties

包括服务

getLocation() - Method in class org.noear.solon.docs.models.ApiGroupResource

getName() - Method in class org.noear.solon.docs.models.ApiGroupResource

getName() - Method in interface org.noear.solon.docs.models.ApiVendorExtension

getPassword() - Method in interface org.noear.solon.docs.BasicAuth

密码

getRoutes() - Method in class org.noear.solon.docs.integration.properties.DocsProperties

路由配置

getSwaggerVersion() - Method in class org.noear.solon.docs.models.ApiGroupResource

getTarget() - Method in class org.noear.solon.docs.DocUpstream

获取服务（addr or name）

getUri() - Method in class org.noear.solon.docs.DocUpstream

获取路径

getUriPattern() - Method in class org.noear.solon.docs.integration.properties.DiscoverProperties

uri 构建模式

getUrl() - Method in class org.noear.solon.docs.models.ApiGroupResource

getUsername() - Method in interface org.noear.solon.docs.BasicAuth

用户

getValue() - Method in interface org.noear.solon.docs.models.ApiVendorExtension

getVersion() - Method in enum org.noear.solon.docs.DocType

获取版本号

globalParams() - Method in class org.noear.solon.docs.DocDocket

全局参数

globalParams(Collection<Object>) - Method in class org.noear.solon.docs.DocDocket

配置全局参数

globalParams(Object) - Method in class org.noear.solon.docs.DocDocket

配置全局参数

globalResponseCodes() - Method in class org.noear.solon.docs.DocDocket

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

globalResponseCodes(Map<Integer, String>) - Method in class org.noear.solon.docs.DocDocket

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

globalResponseInData() - Method in class org.noear.solon.docs.DocDocket

全局响应到data下面

globalResponseInData(boolean) - Method in class org.noear.solon.docs.DocDocket

配置全局响应到data下面

globalResult() - Method in class org.noear.solon.docs.DocDocket

全局结果类

globalResult(Class<?>) - Method in class org.noear.solon.docs.DocDocket

配置全局结果类

groupName() - Method in class org.noear.solon.docs.DocDocket

分组名字

groupName(String) - Method in class org.noear.solon.docs.DocDocket

配置分组名字

H

host() - Method in class org.noear.solon.docs.DocDocket

主机

host(String) - Method in class org.noear.solon.docs.DocDocket

配置主机

I

info() - Method in class org.noear.solon.docs.DocDocket

接口信息

info(ApiInfo) - Method in class org.noear.solon.docs.DocDocket

配置接口信息

INTEGER - Static variable in class org.noear.solon.docs.ApiEnum

io.swagger.solon.annotation - package io.swagger.solon.annotation

isEnable() - Method in interface org.noear.solon.docs.BasicAuth

是否启用

isEnable() - Method in class org.noear.solon.docs.DocDocket

是否启用

isEnabled() - Method in class org.noear.solon.docs.integration.properties.DiscoverProperties

是否启用

isSyncStatus() - Method in class org.noear.solon.docs.integration.properties.DiscoverProperties

同步服务上下线状态

L

license() - Method in class org.noear.solon.docs.models.ApiInfo

license(ApiLicense) - Method in class org.noear.solon.docs.models.ApiInfo

license(String, String) - Method in class org.noear.solon.docs.models.ApiInfo

LONG - Static variable in class org.noear.solon.docs.ApiEnum

M

METHOD_DELETE - Static variable in class org.noear.solon.docs.ApiEnum

METHOD_GET - Static variable in class org.noear.solon.docs.ApiEnum

METHOD_HEAD - Static variable in class org.noear.solon.docs.ApiEnum

METHOD_OPTIONS - Static variable in class org.noear.solon.docs.ApiEnum

METHOD_PATCH - Static variable in class org.noear.solon.docs.ApiEnum

METHOD_POST - Static variable in class org.noear.solon.docs.ApiEnum

METHOD_PUT - Static variable in class org.noear.solon.docs.ApiEnum

N

name(String) - Method in class org.noear.solon.docs.models.ApiContact

name() - Method in class org.noear.solon.docs.models.ApiContact

name(String) - Method in class org.noear.solon.docs.models.ApiLicense

name() - Method in class org.noear.solon.docs.models.ApiLicense

O

onEvent(Discovery) - Method in class org.noear.solon.docs.integration.DiscoverLocator

org.noear.solon.docs - package org.noear.solon.docs

org.noear.solon.docs.exception - package org.noear.solon.docs.exception

org.noear.solon.docs.integration - package org.noear.solon.docs.integration

org.noear.solon.docs.integration.properties - package org.noear.solon.docs.integration.properties

org.noear.solon.docs.models - package org.noear.solon.docs.models

org.noear.solon.docs.util - package org.noear.solon.docs.util

P

PARAM_TYPE_BODY - Static variable in class org.noear.solon.docs.ApiEnum

PARAM_TYPE_COOKIE - Static variable in class org.noear.solon.docs.ApiEnum

PARAM_TYPE_HEADER - Static variable in class org.noear.solon.docs.ApiEnum

PARAM_TYPE_PATH - Static variable in class org.noear.solon.docs.ApiEnum

PARAM_TYPE_QUERY - Static variable in class org.noear.solon.docs.ApiEnum

PRODUCES_DEFAULT - Static variable in class org.noear.solon.docs.ApiEnum

PRODUCES_FILE - Static variable in class org.noear.solon.docs.ApiEnum

PRODUCES_GIF - Static variable in class org.noear.solon.docs.ApiEnum

PRODUCES_JPEG - Static variable in class org.noear.solon.docs.ApiEnum

PRODUCES_JPG - Static variable in class org.noear.solon.docs.ApiEnum

PRODUCES_JSON - Static variable in class org.noear.solon.docs.ApiEnum

PRODUCES_PNG - Static variable in class org.noear.solon.docs.ApiEnum

PRODUCES_XML - Static variable in class org.noear.solon.docs.ApiEnum

R

register(String) - Method in class org.noear.solon.docs.integration.DiscoverLocator

注册

RES_ARRAY - Static variable in class org.noear.solon.docs.ApiEnum

RES_BOOLEAN - Static variable in class org.noear.solon.docs.ApiEnum

RES_INTEGER - Static variable in class org.noear.solon.docs.ApiEnum

RES_OBJECT - Static variable in class org.noear.solon.docs.ApiEnum

RES_STRING - Static variable in class org.noear.solon.docs.ApiEnum

response401(Context) - Static method in class org.noear.solon.docs.util.BasicAuthUtil

S

schemes() - Method in class org.noear.solon.docs.DocDocket

协议架构（http, https）

schemes(String...) - Method in class org.noear.solon.docs.DocDocket

配置协议架构（http, https）

SCHEMES_HTTP - Static variable in class org.noear.solon.docs.ApiEnum

SCHEMES_HTTPS - Static variable in class org.noear.solon.docs.ApiEnum

SCHEMES_WS - Static variable in class org.noear.solon.docs.ApiEnum

SCHEMES_WSS - Static variable in class org.noear.solon.docs.ApiEnum

securityExtensions() - Method in class org.noear.solon.docs.DocDocket

安全扩展

securityExtensions(Map<String, Object>) - Method in class org.noear.solon.docs.DocDocket

配置安全扩展

securityExtensions(String, Object) - Method in class org.noear.solon.docs.DocDocket

配置安全扩展

serializer() - Method in class org.noear.solon.docs.DocDocket

序列化

serializer(Serializer<String>) - Method in class org.noear.solon.docs.DocDocket

配置序列化

SOLON_DOCS - Static variable in class org.noear.solon.docs.integration.DocsPlugin

start() - Method in class org.noear.solon.docs.integration.DiscoverLocator

开始

start(AppContext) - Method in class org.noear.solon.docs.integration.DocsPlugin

STRING - Static variable in class org.noear.solon.docs.ApiEnum

syncStatus(Discovery) - Method in class org.noear.solon.docs.integration.DiscoverLocator

同步状态

T

termsOfService() - Method in class org.noear.solon.docs.models.ApiInfo

termsOfService(String) - Method in class org.noear.solon.docs.models.ApiInfo

test(Action) - Method in class org.noear.solon.docs.models.ApiResource

title() - Method in class org.noear.solon.docs.models.ApiInfo

title(String) - Method in class org.noear.solon.docs.models.ApiInfo

toValue() - Method in enum org.noear.solon.docs.models.ApiScheme

U

upstream() - Method in class org.noear.solon.docs.DocDocket

获取上游

upstream(DocUpstream) - Method in class org.noear.solon.docs.DocDocket

配置上游

upstream(String, String, String) - Method in class org.noear.solon.docs.DocDocket

配置上游

url(String) - Method in class org.noear.solon.docs.models.ApiContact

url() - Method in class org.noear.solon.docs.models.ApiContact

url() - Method in class org.noear.solon.docs.models.ApiExternalDocs

url(String) - Method in class org.noear.solon.docs.models.ApiLicense

url() - Method in class org.noear.solon.docs.models.ApiLicense

V

valueOf(String) - Static method in enum org.noear.solon.docs.DocType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.noear.solon.docs.models.ApiScheme

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.noear.solon.docs.DocType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.noear.solon.docs.models.ApiScheme

Returns an array containing the constants of this enum type, in the order they are declared.

vendorExtensions() - Method in class org.noear.solon.docs.DocDocket

供应商扩展

vendorExtensions(Map<String, Object>) - Method in class org.noear.solon.docs.DocDocket

配置供应商扩展

vendorExtensions(String, Object) - Method in class org.noear.solon.docs.DocDocket

配置供应商扩展

vendorExtensions(List<ApiVendorExtension>) - Method in class org.noear.solon.docs.DocDocket

配置供应商扩展

vendorExtensions() - Method in class org.noear.solon.docs.models.ApiContact

vendorExtensions() - Method in class org.noear.solon.docs.models.ApiLicense

version() - Method in class org.noear.solon.docs.DocDocket

版本号

version(String) - Method in class org.noear.solon.docs.DocDocket

配置版本号

version() - Method in class org.noear.solon.docs.models.ApiInfo

version(String) - Method in class org.noear.solon.docs.models.ApiInfo

A B C D E F G H I L M N O P R S T U V