ThinkPHP配置二级域名实现API文档隔离:Swagger独立子域名部署【指南】

老磊姑娘_6611

老磊姑娘_6611

2026-06-17

300人浏览

原创

thinkphp 通过 dns、nginx、框架路由与应用结构四层协同,以独立 swagger 应用、专属 server 块、swagger.php 入口及静态资源路由实现二级域名 api 文档隔离。

thinkphp配置二级域名实现api文档隔离:swagger独立子域名部署【指南】

ThinkPHP 配置二级域名实现 Swagger API 文档隔离,核心是让 api.example.com 独立承载文档站点,与主站(www.example.com)和后台(admin.example.com)完全解耦,既保障安全性,又避免路由冲突、权限干扰或静态资源污染。这不是简单改个 URL,而是需在 DNS、Web 服务器、框架路由、应用结构四层协同落地。

一、前置:确认多应用结构已就绪

Swagger 文档站点建议作为独立应用部署(如 app/swagger/),而非挂载在 admin 或 api 模块下。这样可单独配置中间件、静态资源路径和访问策略。

  • 执行 php think build swagger 创建独立应用目录
  • 确保 app/ 下存在 swagger/ 目录,含自己的 controller/、route.php 和 config/
  • 删除根目录 app/controller/(触发 ThinkPHP 进入多应用识别模式)

二、Nginx 配置专属 server 块

不依赖 PHP 层解析 Host,直接由 Web 服务器分发请求,性能更稳、上下文更干净。这是生产环境推荐方式。

  • 新增 Nginx 配置文件(如 /etc/nginx/conf.d/swagger.conf)
  • server_name 设为 api.example.com(注意不是 www 或 admin)
  • root 指向项目 public/ 目录(非 swagger 子目录)
  • index 设为 swagger.php(自定义入口文件)
  • 在 location ~ \.php$ 中显式传参:fastcgi_param SCRIPT_FILENAME $document_root/swagger.php;

三、创建独立入口文件 swagger.php

该文件位于 public/swagger.php,内容精简明确:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • 定义 APP_NAME = 'swagger'
  • 引入框架自动加载器:require __DIR__ . '/../vendor/autoload.php';
  • 启动应用:(new think\App())->run()->send();

此举确保所有请求进入 app/swagger/ 应用上下文,与其它应用物理隔离。

四、Swagger 静态资源与路由绑定

Swagger UI 是前端静态页面,需正确暴露资源并配置后端接口代理(如需):

  • 将 Swagger UI 文件(如 dist/)放入 public/static/swagger/
  • 在 app/swagger/route.php 中注册首页路由:Route::get('/', function () { return redirect('/static/swagger/index.html'); });
  • 若需对接真实 API 接口,可在该应用内配置反向代理中间件,或通过 CORS 允许跨域调用 api.example.com 的后端服务

不复杂但容易忽略

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

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

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

下载

相关标签:

thinkphp php

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10804

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6301

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2135

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3988

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4694

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3671

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5277

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4122

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12042

4

热门下载

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

精品课程

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