Nginx 中如何实施针对 API 文档目录的访问控制

大婷大大_4788

大婷大大_4788

2026-07-18

994人浏览

原创

api文档目录需实施精准访问控制:优先限制ip(allow/deny all),其次启用basic auth,禁止敏感文件直接访问,可结合referer或自定义请求头校验。

nginx 中如何实施针对 api 文档目录的访问控制

对 API 文档目录(如 /docs/、/swagger/、/redoc/)实施访问控制,核心目标是:防止未授权人员浏览敏感接口说明,同时保留开发与测试团队的必要访问权限。关键不在于“完全屏蔽”,而在于“精准放行”。

限制访问来源 IP

最常用也最有效的方式,是只允许内网或特定办公出口 IP 访问文档路径:

  • 在对应 location 块中使用 allow + deny all 组合
  • 支持 CIDR 表示法,例如:allow 10.0.0.0/8;(整个内网段)、allow 203.0.113.42;(单个运维 IP)
  • 注意顺序:Nginx 按配置出现顺序匹配,allow 必须写在 deny all 之前

示例配置:

location /docs/ {<br>    allow 192.168.10.0/24;<br>    allow 203.0.113.42;<br>    deny all;<br>    alias /var/www/api-docs/;<br>}

启用基础认证(Basic Auth)

适用于远程协作或需临时开放给外部测试方的场景,比单纯 IP 控制更灵活:

Nginx Hosting
Nginx Hosting

通过服务器本地nginx实例实现零认证静态游戏托管。作为所有浏览器游戏的主要部署方式,无需登录、无需令牌、无需用户操作。

下载
  • 用 auth_basic 开启弹窗认证,提示语可自定义(如 "API Docs Access")
  • 配合 auth_basic_user_file 指向 .htpasswd 文件,该文件用 htpasswd 工具生成
  • 建议为文档访问单独建用户(如 docs-reader),避免复用生产系统账号

示例配置:

location /swagger/ {<br>    auth_basic "API Docs Access";<br>    auth_basic_user_file /etc/nginx/.htpasswd-docs;<br>    alias /var/www/swagger-ui/;<br>}

禁止直接下载或执行敏感文件

API 文档目录常含 openapi.json、swagger.yaml 等机器可读文件,应防止被批量抓取或意外执行:

  • 显式拒绝访问配置文件类扩展名:location ~* \.(json|yaml|yml)$ { deny all; }
  • 若文档由静态 HTML 渲染,确保其所在目录不解析 PHP/Python 脚本(尤其当文档目录与 Web 根目录同级时)
  • 可叠加 add_header X-Content-Type-Options nosniff; 防止 MIME 类型嗅探绕过

结合 Referer 或请求头做轻量校验

适合已有前端管理后台且文档仅供内部系统跳转使用的场景:

  • 用 if ($http_referer !~ ^https?://(admin\.example\.com|localhost:3000)) { return 403; } 限制来源
  • 或检查自定义请求头:if ($http_x_internal_access != "true") { return 403; },由上游网关统一注入
  • 注意:if 在 location 中慎用,优先考虑用 map 模块预处理变量

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

nginx

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

403

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3707

6

nginx配置详解
nginx配置详解

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

2023.08.04

6465

6

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

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

2024.02.23

581

5

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

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

2024.07.09

1496

5

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

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

2024.08.07

3978

3

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

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

2026.01.13

122

12

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

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

2026.01.13

497

23

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

2026.03.16

159

12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpEnv手册
phpEnv手册

共0课时 | 0人学习

nginx手册
nginx手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习