讲师中心 微信公众号
AI工具推荐 视频效率加速

如何利用 autoindex_format 自定义文件列表输出格式(JSON/XML)

小丽君_6599

小丽君_6599

发布时间:2026-05-14 12:27:47

|

942人浏览过

|

来源于php中文网

原创

Nginx官方版本不支持autoindex_format指令,无法原生输出JSON/XML目录列表;需借助第三方模块(如nginx_autoindex_module)、OpenResty的Lua脚本或后端服务实现结构化输出,同时须注意安全限制与配置细节。

如何利用 autoindex_format 自定义文件列表输出格式(json/xml)

Nginx 本身不支持 autoindex_format 指令,也**不原生提供 JSON 或 XML 格式的目录列表输出**。所谓 autoindex_format 是常见误解,实际是某些第三方模块(如 nginx_autoindex_module)或自定义编译版 Nginx 才具备的扩展功能,标准 Nginx 官方版本中并不存在该指令。

确认你用的是支持 autoindex_format 的增强版 Nginx

标准 Nginx 的 autoindex on 只能生成固定格式的 HTML 列表,无法输出 JSON/XML。若需结构化目录数据,必须满足以下任一条件:

  • 已安装并启用第三方模块(如 nginx_autoindex_module),且在编译时启用了 --add-module=...
  • 使用 OpenResty(内置 Lua)自行构造响应体
  • 借助后端服务(如 Python/Node.js)代理请求并生成结构化目录

使用 nginx_autoindex_module 输出 JSON

该模块扩展了 autoindex_format 指令,支持 json 和 xml 值。配置示例如下:

location /files/ {
    autoindex on;
    autoindex_format json;  # 关键:启用 JSON 输出
    autoindex_exact_size off;
    autoindex_localtime on;
}

访问 /files/ 将返回类似:

Node.js 可靠编程
Node.js 可靠编程

Node.js 可靠编程技能。避免事件循环阻塞、异步陷阱、ESM 兼容问题和内存泄漏。触发词:Node.js 开发、async/await、流处理、性能优化、安全编码。

下载
[
  {"name":"..","type":"dir","mtime":"2024-01-01T12:00:00+00:00","size":0},
  {"name":"document.pdf","type":"file","mtime":"2024-05-20T09:30:15+00:00","size":204800}
]

注意:autoindex_format json 仅在模块启用且请求头无 Accept: text/html 时生效;部分版本默认仍返回 HTML,需配合 autoindex_ignore_accept_header on 强制启用。

替代方案:用 Lua + ngx.dir.read 实现灵活输出(OpenResty)

更可控、无需额外模块的方式是使用 OpenResty 的 Lua 脚本遍历目录并构造响应:

location /api/list/ {
    content_by_lua_block {
        local cjson = require "cjson"
        local dir = "/var/www/files/"
        local files = {}
        local dh = ngx.dir.open(dir)
        if not dh then
            ngx.status = 500
            ngx.say('{"error":"cannot open directory"}')
            return
        end
        local f
        while true do
            f = dh:read()
            if not f then break end
            if f ~= "." and f ~= ".." then
                local st = ngx.stat(dir .. f)
                table.insert(files, {
                    name = f,
                    type = st.type == "directory" and "dir" or "file",
                    size = st.size or 0,
                    mtime = os.date("!*t", st.mtim)
                })
            end
        end
        dh:close()
        ngx.header.content_type = "application/json"
        ngx.say(cjson.encode(files))
    }
}

此方式可自由定制字段、过滤规则、权限控制,且兼容标准 OpenResty 部署。

安全与实用提醒

开放目录列表存在风险,务必注意:

  • 避免暴露敏感路径(如 /etc/、/var/log/)
  • 对 /files/ 类路径启用访问控制(allow/deny 或 auth_basic)
  • JSON/XML 接口建议加 CORS 头(若前端调用):add_header 'Access-Control-Allow-Origin' '*';
  • 大目录下避免阻塞式遍历,可考虑缓存或异步扫描

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

423

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

4027

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

6885

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

601

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1516

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3978

2024.08.07

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

122

2026.01.13

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

537

2026.01.13

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn