Sign in

    q2316367743/open-list/public does not have a README file

    InitSetupBody

    type InitSetupBody derive(ToJson)

    发送初始化请求的请求体(POST /api/public/init/setup)。

    InitSetupBody::to_json

    显式声明 derive 出来的 ToJson 实现。

    PublicApi

    pub struct PublicApi {
    // private fields
    }

    公开域:/api/public/*——不需要登录就能访问的服务器信息与安装流程。

    这些端点在服务端没有挂认证中间件,因此客户端即使在匿名状态 (Credentials::Token("") 或尚未登录)也能调用。

    PublicApi::archive_extensions

    async fn PublicApi::archive_extensions(self : PublicApi) -> Array[String] raise
    OpenListError

    服务端支持的归档扩展名(GET /api/public/archive_extensions)。

    用来判断哪些文件可以走 /api/fs/archive/* 解压。

    PublicApi::init_setup

    async fn PublicApi::init_setup(self : PublicApi, username : String, password : String, site_title? : String) -> Unit raise
    OpenListError

    执行系统初始化,创建首个管理员账号(POST /api/public/init/setup)。

    只在尚未初始化时可用:重复调用会拿到 400(system has already beeninitialized);密码要求至少 4 个字符(服务端校验,不满足也是 400)。

    PublicApi::init_status

    查询系统是否已经初始化(GET /api/public/init_status)。

    未初始化时 initialized 为假,此时才能调用 init_setup。

    PublicApi::new

    由根包创建。

    PublicApi::offline_download_tools

    async fn PublicApi::offline_download_tools(self : PublicApi, path? : String) -> Array[String] raise
    OpenListError

    某个路径下可用的离线下载工具名(GET /api/public/offline_download_tools)。

    path 不给时返回所有工具(服务端按路径筛选可用驱动)。

    PublicApi::settings

    async fn PublicApi::settings(self : PublicApi) -> Map[String, String] raise
    OpenListError

    读取服务器的公开设置(GET /api/public/settings)。

    返回站点标题、版本号一类的键值对;键名以服务端为准。

    Source Files