- 用户功能
- 用户接口
- 服务端代理上传
- SharePoint 工具辅助模块
- S3 工具辅助模块
- OnlyOffice 相关接口
- gd 工具辅助模块
- 文件列表模块
- 站点基础模块
- 直短链模块
- 初始化模块
- 文件操作模块
- 服务端代理下载
- OneDrive 认证回调模块
- Google Drive 认证回调模块
- 站点基础模块
- 短链
- 单点登录
- 管理员功能
- 站点设置模块
- 用户管理
- 规则管理-显示规则(Pro)
- 存储源模块-基础
- 存储源模块-README
- 存储源模块-密码文件夹
- 存储源模块-过滤文件
- 规则管理-上传规则
- 规则匹配辅助 Controller
- 直链管理
- 直链日志管理
- 登录模块
- 存储源模块-元数据
- 存储源模块-权限控制
- 权限模块
- 登录日志管理
- IP 地址辅助 Controller
- 单点登录管理接口
- 数据模型
- Schemas
- AjaxJsonString
- AjaxJsonObject
- AjaxJsonMapStringString
- AjaxJsonVoid
- ResetAdminUserNameAndPasswordRequest
- UpdateWebDAVRequest
- UpdateUserPwdRequest
- UpdateViewSettingRequest
- UserLoginRequest
- UpdateSiteSettingRequest
- AjaxJsonLoginResult
- UpdateSecuritySettingRequest
- 响应数据
- SharePointSearchSitesRequest
- UpdateLinkSettingRequest
- AjaxJsonListSharepointSiteResult
- UpdateAccessSettingRequest
- 响应数据
- SaveUserRequest
- SharePointSiteListsRequest
- 授予给用户的存储策略列表
- AjaxJsonListSharepointSiteListResult
- AjaxJsonUser
- 响应数据
- 响应数据
- SharePointInfoRequest
- UserRuleSettingDTO
- S3 bucket 列表请求类
- UserUploadRule
- S3 bucket 列表请求类
- AjaxJsonListZFileCORSRule
- UserViewRule
- 响应数据
- AjaxJsonUserRuleSettingDTO
- AjaxJsonListS3 Bucket 名称结果类
- AjaxJsonInteger
- S3 bucket 列表请求类
- S3 bucket 名称结果类
- CopyUserRequest
- AjaxJsonListS3BucketNameResult
- FileItemRequest
- SaveStorageSourceRequest
- S3 bucket 名称结果类
- AjaxJsonJSONObject
- 存储源拓展属性
- gd drive 列表请求类
- readme 文档配置
- readme 文档配置
- AjaxJsonListGd Drive 基本信息结果类
- 密码设置
- gd drive 列表请求类
- 密码设置
- gd drive 基本信息结果类
- 存储源过滤配置
- AjaxJsonListGoogleDriveInfoResult
- 存储源过滤配置
- SearchStorageRequest
- UpdateStorageSortRequest
- gd drive 基本信息结果类
- AjaxJsonList文件列表信息结果类
- CopyStorageSourceRequest
- 文件列表信息结果类
- RuleViewItem
- AjaxJsonListFileItemResult
- 单点登录厂商配置
- FileListRequest
- TestViewRuleRequest
- 文件列表信息结果类
- AjaxJsonSsoConfig
- AjaxJson文件列表信息结果类
- AjaxJsonRuleViewItem
- FileListConfigRequest
- RuleDTORuleViewItem
- AjaxJsonFileInfoResult
- AjaxJson存储源设置响应类
- AjaxJsonRuleDTORuleViewItem
- 文件列表信息结果类
- 存储源元数据
- RuleUploadItem
- AjaxJsonFileItemResult
- 存储源设置响应类
- TestUploadRuleRequest
- BatchGenerateLinkRequest
- AjaxJsonRuleUploadItem
- AjaxJsonStorageSourceConfigResult
- AjaxJsonListBatchGenerateLinkResponse
- RuleDTORuleUploadItem
- 存储源设置响应类
- 响应数据
- AjaxJsonRuleDTORuleUploadItem
- InstallSystemRequest
- TestRuleMatcherRequest
- BatchMoveOrCopyFileRequest
- AjaxJsonListBatchOperatorResult
- QueryDownloadLogRequest
- 响应数据
- VerifyLoginTwoFactorAuthenticatorRequest
- UploadFileRequest
- AjaxJsonUserDetailResponse
- RenameFolderRequest
- 响应数据
- RenameFileRequest
- UserStorageSourceDetailDTO
- NewFolderRequest
- QueryUserRequest
- BatchDeleteRequest
- AjaxJsonCollectionUserDetailResponse
- 删除的文件详情
- CheckUserDuplicateRequest
- AjaxJsonLoginVerifyModeEnum
- AjaxJsonCheckLoginResult
- AjaxJsonStorageTypeEnum[]
- 响应数据
- AjaxJsonListStorageSourceAdminResult
- AjaxJsonLoginVerifyImgResult
- 存储源刷新信息
- 响应数据
- 响应数据
- AjaxJsonListStorageSourceResult
- AjaxJsonStorageSourceDTO
- 响应数据
- 响应数据
- RefreshTokenInfoDTO
- AjaxJson全局站点设置响应类
- AjaxJsonListReadme 文档配置
- 短链过期时间设置
- AjaxJsonListPermissionConfigResult
- ApplicationContext
- 全局站点设置响应类
- 响应数据
- AutowireCapableBeanFactory
- AjaxJsonBoolean
- AjaxJsonList密码设置
- BeanFactory
- AjaxJsonListReadmeConfig
- Action
- AjaxJsonList存储源过滤配置
- Environment
- OnlyOfficeCallback
- AjaxJsonListStorageSourceParamDef
- FilterRegistration
- Options
- HttpStatusCode
- AjaxJsonListPasswordConfig
- 响应数据
- JspConfigDescriptor
- AjaxJsonListFilterConfig
- QueryRuleRequest
- JspPropertyGroupDescriptor
- AjaxJsonCollectionRuleView
- RedirectView
- 响应数据
- ServletContext
- CheckRuleDuplicateRequest
- ServletRegistration
- AjaxJsonCollectionSsoConfig
- AjaxJsonCollectionRuleUpload
- SessionCookieConfig
- CheckProviderDuplicateRequest
- 响应数据
- TaglibDescriptor
- AjaxJsonListPermissionInfoResult
- 响应数据
- QueryLoginLogRequest
- AjaxJsonListSsoLoginItemResponse
- AjaxJsonListLoginLog
- 响应数据
- 响应数据
- AjaxJsonFrontSiteConfigResult
- QueryShortLinkLogRequest
- 全局站点设置响应类
- AjaxJsonListShortLinkResult
- 响应数据
- AjaxJsonListCacheInfoStringAtomicInteger
- 响应数据
- DownloadTopInfoRequest
- AjaxJsonListDownloadTopRefererDTO
- 响应数据
- AjaxJsonListDownloadTopIpDTO
- 响应数据
- AjaxJsonListDownloadTopFileDTO
- 响应数据
- AjaxJsonStreamDownloadLogResult
- AjaxJsonSystemConfigDTO
- 响应数据
- AjaxJsonLoginTwoFactorAuthenticatorResult
- 响应数据
- Schemas
获取存储源文档文件夹列表
GET
https://demo.zfile.vip/admin/storage/{storageId}/readme
请求参数
Path 参数
Header 参数
请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://demo.zfile.vip/admin/storage//readme' \
--header 'zfile-token;'返回响应
🟢200成功
*/*
Body*/*
示例
{
"code": "0",
"msg": "ok",
"data": [
{
"id": 1,
"storageId": 0,
"description": "用来辅助记忆表达式",
"expression": "string",
"readmeText": "string",
"displayMode": "top"
}
],
"dataCount": 0,
"traceId": "string"
}🟠400请求有误
🟠401没有权限
🟠403禁止访问
🟠404记录不存在
🟠405405
🔴500服务器错误
修改于 2025-07-10 12:40:02