org.noear.solon.docs

类 DocDocket

java.lang.Object

org.noear.solon.docs.DocDocket

public class DocDocket
extends java.lang.Object

文档摘要

构造器概要

构造器

构造器和说明
DocDocket()

方法概要

限定符和类型	方法和说明
java.util.List<ApiResource>	apis()
DocDocket	apis(ApiResource apiResource)
DocDocket	apis(java.lang.String basePackage)
java.lang.String	basePath()
DocDocket	basePath(java.lang.String basePath) 格式：admin#123456,user#654321,张三#abc
java.util.Map<java.lang.String,java.lang.String>	basicAuth()
DocDocket	basicAuth(BasicAuth basicAuth)
DocDocket	basicAuth(java.lang.String username, java.lang.String password)
ApiExternalDocs	externalDocs()
DocDocket	externalDocs(ApiExternalDocs externalDocs)
DocDocket	externalDocs(java.lang.String description, java.lang.String url)
java.util.Set<java.lang.Object>	globalParams()
DocDocket	globalParams(java.util.Collection<java.lang.Object> globalParams)
DocDocket	globalParams(java.lang.Object param)
java.util.Map<java.lang.Integer,java.lang.String>	globalResponseCodes()
DocDocket	globalResponseCodes(java.util.Map<java.lang.Integer,java.lang.String> globalResponseCodes)
boolean	globalResponseInData()
DocDocket	globalResponseInData(boolean globalResponseInData)
java.lang.Class<?>	globalResult()
DocDocket	globalResult(java.lang.Class<?> clz)
java.lang.String	groupName()
DocDocket	groupName(java.lang.String groupName)
java.lang.String	host()
DocDocket	host(java.lang.String host)
ApiInfo	info()
DocDocket	info(ApiInfo info)
java.util.List<ApiScheme>	schemes()
DocDocket	schemes(java.lang.String... schemes)
java.util.Map<java.lang.String,java.lang.Object>	securityExtensions()
DocDocket	securityExtensions(java.util.Map<java.lang.String,java.lang.Object> securityExtensions)
DocDocket	securityExtensions(java.lang.String name, java.lang.Object value)
java.util.Map<java.lang.String,java.lang.Object>	vendorExtensions()
DocDocket	vendorExtensions(java.util.List<ApiVendorExtension> extensions)
DocDocket	vendorExtensions(java.util.Map<java.lang.String,java.lang.Object> vendorExtensions)
DocDocket	vendorExtensions(java.lang.String name, java.lang.Object value)
java.lang.String	version()
DocDocket	version(java.lang.String version)

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

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

构造器详细资料

DocDocket

public DocDocket()

方法详细资料

version

public java.lang.String version()

version

public DocDocket version(java.lang.String version)

host

public java.lang.String host()

host

public DocDocket host(java.lang.String host)

schemes

public java.util.List<ApiScheme> schemes()

schemes

public DocDocket schemes(java.lang.String... schemes)

groupName

public java.lang.String groupName()

groupName

public DocDocket groupName(java.lang.String groupName)

basePath

public java.lang.String basePath()

basePath

public DocDocket basePath(java.lang.String basePath)

格式：admin#123456,user#654321,张三#abc

basicAuth

public java.util.Map<java.lang.String,java.lang.String> basicAuth()

basicAuth

public DocDocket basicAuth(java.lang.String username,
                           java.lang.String password)

basicAuth

public DocDocket basicAuth(BasicAuth basicAuth)

apis

public java.util.List<ApiResource> apis()

apis

public DocDocket apis(java.lang.String basePackage)

apis

public DocDocket apis(ApiResource apiResource)

info

public ApiInfo info()

info

public DocDocket info(ApiInfo info)

globalResponseInData

public boolean globalResponseInData()

globalResponseInData

public DocDocket globalResponseInData(boolean globalResponseInData)

globalResponseCodes

public java.util.Map<java.lang.Integer,java.lang.String> globalResponseCodes()

globalResponseCodes

public DocDocket globalResponseCodes(java.util.Map<java.lang.Integer,java.lang.String> globalResponseCodes)

globalResult

public java.lang.Class<?> globalResult()

globalResult

public DocDocket globalResult(java.lang.Class<?> clz)

globalParams

public java.util.Set<java.lang.Object> globalParams()

globalParams

public DocDocket globalParams(java.util.Collection<java.lang.Object> globalParams)

globalParams

public DocDocket globalParams(java.lang.Object param)

externalDocs

public ApiExternalDocs externalDocs()

externalDocs

public DocDocket externalDocs(ApiExternalDocs externalDocs)

externalDocs

public DocDocket externalDocs(java.lang.String description,
                              java.lang.String url)

vendorExtensions

public java.util.Map<java.lang.String,java.lang.Object> vendorExtensions()

vendorExtensions

public DocDocket vendorExtensions(java.util.Map<java.lang.String,java.lang.Object> vendorExtensions)

vendorExtensions

public DocDocket vendorExtensions(java.lang.String name,
                                  java.lang.Object value)

vendorExtensions

public DocDocket vendorExtensions(java.util.List<ApiVendorExtension> extensions)

securityExtensions

public java.util.Map<java.lang.String,java.lang.Object> securityExtensions()

securityExtensions

public DocDocket securityExtensions(java.util.Map<java.lang.String,java.lang.Object> securityExtensions)

securityExtensions

public DocDocket securityExtensions(java.lang.String name,
                                    java.lang.Object value)