| Package | Description |
|---|---|
| org.noear.solon.docs | |
| org.noear.solon.docs.integration.properties | |
| org.noear.solon.docs.util |
| Modifier and Type | Method and Description |
|---|---|
DocDocket |
DocDocket.apis(ApiResource apiResource)
配置接口资源
|
DocDocket |
DocDocket.apis(String basePackage)
配置接口资源
|
DocDocket |
DocDocket.basePath(String basePath)
配置基础路径
|
DocDocket |
DocDocket.basicAuth(BasicAuth basicAuth)
配置基础鉴权
|
DocDocket |
DocDocket.basicAuth(String username,
String password)
配置基础鉴权
|
DocDocket |
DocDocket.enable(boolean enable)
配置是否启用
|
DocDocket |
DocDocket.externalDocs(ApiExternalDocs externalDocs)
配置外部文档
|
DocDocket |
DocDocket.externalDocs(String description,
String url)
配置外部文档
|
DocDocket |
DocDocket.globalParams(Collection<Object> globalParams)
配置全局参数
|
DocDocket |
DocDocket.globalParams(Object param)
配置全局参数
|
DocDocket |
DocDocket.globalResponseCodes(Map<Integer,String> globalResponseCodes)
配置全局响应代码描述(401,403...)
|
DocDocket |
DocDocket.globalResponseInData(boolean globalResponseInData)
配置全局响应到data下面
|
DocDocket |
DocDocket.globalResult(Class<?> clz)
配置全局结果类
|
DocDocket |
DocDocket.groupName(String groupName)
配置分组名字
|
DocDocket |
DocDocket.host(String host)
配置主机
|
DocDocket |
DocDocket.info(ApiInfo info)
配置接口信息
|
DocDocket |
DocDocket.schemes(String... schemes)
配置协议架构(http, https)
|
DocDocket |
DocDocket.securityExtensions(Map<String,Object> securityExtensions)
配置安全扩展
|
DocDocket |
DocDocket.securityExtensions(String name,
Object value)
配置安全扩展
|
DocDocket |
DocDocket.upstream(DocUpstream upstream)
配置上游
|
DocDocket |
DocDocket.upstream(String target,
String contextPath,
String path)
配置上游
|
DocDocket |
DocDocket.vendorExtensions(List<ApiVendorExtension> extensions)
配置供应商扩展
|
DocDocket |
DocDocket.vendorExtensions(Map<String,Object> vendorExtensions)
配置供应商扩展
|
DocDocket |
DocDocket.vendorExtensions(String name,
Object value)
配置供应商扩展
|
DocDocket |
DocDocket.version(String version)
配置版本号
|
| Modifier and Type | Class and Description |
|---|---|
class |
DocDocketProperties
文档摘要属性
|
| Modifier and Type | Method and Description |
|---|---|
static boolean |
BasicAuthUtil.basicAuth(org.noear.solon.core.handle.Context ctx,
DocDocket docket)
WWW-Authenticate 简单认证
|
Copyright © 2025. All rights reserved.