Hyperf Swagger组件CDN资源加载问题分析与解决方案

2025-06-03 11:24:49作者：姚月梅Lane

项目地址：https://gitcode.com/gh_mirrors/hyp/hyperf

问题背景

在使用Hyperf框架的Swagger组件时，部分用户遇到了Swagger UI界面无法正常显示的问题。具体表现为访问Swagger文档页面时出现白屏，浏览器控制台显示421 Misdirected Request错误。这个问题主要影响日本等地区的用户，原因是组件中引用的CDN资源域名出现了访问问题。

问题分析

Hyperf Swagger组件在生成Swagger UI界面时，默认会从特定CDN地址加载所需的CSS和JavaScript资源。当这些资源无法正常加载时，就会导致界面无法渲染，出现白屏现象。

421 Misdirected Request是HTTP协议中的一个状态码，表示请求被发送到了无法响应该请求的服务器。这种情况通常发生在使用CDN服务时，由于DNS解析或服务器配置问题导致的请求路由错误。

解决方案

方法一：使用本地资源文件

最可靠的解决方案是将Swagger UI所需的资源文件本地化，具体步骤如下：

在项目storage目录下创建swagger文件夹
创建swagger-ui.html文件，内容如下：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <meta name="description" content="SwaggerUI" />
    <title>SwaggerUI</title>
    <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5.14.0/swagger-ui.css" />
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://unpkg.com/swagger-ui-dist@5.14.0/swagger-ui-bundle.js" crossorigin></script>
<script src="https://unpkg.com/swagger-ui-dist@5.14.0/swagger-ui-standalone-preset.js" crossorigin></script>
<script>
    window.onload = () => {
        window.ui = SwaggerUIBundle({
            url: GetQueryString("search"),
            dom_id: '#swagger-ui',
            presets: [
                SwaggerUIBundle.presets.apis,
                SwaggerUIStandalonePreset
            ],
            layout: "StandaloneLayout",
        });
    };
    function GetQueryString(name) {
        var reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)", "i");
        var r = window.location.search.substr(1).match(reg);
        var context = "";
        if (r != null)
            context = decodeURIComponent(r[2]);
        reg = null;
        r = null;
        return context == null || context == "" || context == "undefined" ? "/http.json" : context;
    }
</script>
</body>
</html>

修改swagger.php配置文件：

'html' => file_get_contents(BASE_PATH . '/storage/swagger/swagger-ui.html'),

方法二：更新Hyperf框架版本

该问题已在Hyperf框架的后续版本中得到修复。开发者可以考虑升级框架版本到包含修复补丁的版本。

最佳实践建议

生产环境推荐：在生产环境中，建议使用方法一的本地资源方案，这样可以避免依赖外部CDN服务，提高稳定性和加载速度。
资源版本控制：如果使用本地资源方案，应该定期检查并更新Swagger UI的资源版本，以获取最新的功能和安全修复。
自定义配置：可以根据项目需求，进一步自定义Swagger UI的界面和功能，例如添加认证信息、修改主题等。
缓存策略：对于频繁访问的API文档页面，可以考虑实现缓存机制，减少资源加载时间。

总结

Hyperf Swagger组件的CDN资源加载问题是一个典型的依赖外部服务导致的可用性问题。通过将关键资源本地化，开发者可以完全掌控API文档的展示效果和可用性，避免因第三方服务问题影响开发体验。这种解决方案不仅适用于当前问题，也是处理类似依赖问题的一般性原则。

hyperf

项目地址：https://gitcode.com/gh_mirrors/hyp/hyperf

登录后查看全文

项目优选

收起

kernel

deepin linux kernel

docs

OpenHarmony documentation | OpenHarmony开发者文档

Ascend Extension for PyTorch

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用

Java

RuoYi-Vue3

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer（第 2 版）》、《程序员面试金典（第 6 版）》题解

Java

openGauss-server

openGauss kernel ~ openGauss is an open source relational database management system

C++

160

219