autoindex_format
'autoindex_format' 指令定义了 NGINX 的 autoindex 模块生成的目录列表的格式。 — NGINX HTTP Core
autoindex_format
httpserverlocation
语法autoindex_format format;
默认值html
上下文http, server, location
模块NGINX HTTP Core
参数1
说明
`autoindex_format` 指令用于指定在启用 NGINX 的 autoindex 功能时目录列表的输出格式。该指令允许用户更改生成的 HTML 的外观,以提高可读性或实现自定义。NGINX 支持若干预定义格式,例如 `html` 和 `json`,每种格式对应不同的呈现风格。当在配置文件中设置该指令时,NGINX 会使用指定的输出格式,而不是回退到默认配置,从而增强目录索引对可能依赖响应中特定数据结构的客户端或应用程序的可用性。 在实际场景中,`autoindex_format` 可用于以友好的 HTML 方式展示目录内容(例如包含链接和文件大小),或以 `json` 格式用于 API 消费,这样可以被程序化地解析。该格式必须在有效的上下文中设置,具体为 `http`、`server` 或 `location` 级别,从而允许根据 NGINX 配置的作用域进行全面控制。该指令主要支持与各种客户端应用的集成,这些应用根据其期望的格式以不同方式处理目录列表。
配置示例
location /files {
autoindex on;
autoindex_format json;
}⚠
在使用此指令之前,请确保已启用 autoindex 模块并执行 'autoindex on;'。
⚠
指定未知的格式会导致错误;请仅使用受支持的格式。