本文介绍在 php 中获取 npm 包 readme 的可靠方法：优先尝试 npm registry 的 `readme` 字段，若缺失则通过包中声明的 github 仓库地址 + github rest api 动态拉取 readme.md 内容。

NPM 官方 registry（https://www.php.cn/link/f3a22d6edd297a48ac3189878051a52f）虽不保证所有包都内嵌 README，但部分包确实在其元数据中直接提供了 readme 字段。例如访问 https://www.php.cn/link/f3a22d6edd297a48ac3189878051a52fnpm 可看到顶层 “readme” 键包含已渲染的纯文本 README；而 https://www.php.cn/link/f3a22d6edd297a48ac3189878051a52freact 则无此字段——这取决于发布者是否在 npm publish 时将 README 嵌入 tarball 元数据（npm CLI 自 v7+ 默认启用，但历史包或自定义打包流程可能遗漏）。

因此，稳健的 PHP 实现应采用双路径回退策略：

1. 首选：从 registry 获取内嵌 README
   发起 GET 请求至 https://www.php.cn/link/f3a22d6edd297a48ac3189878051a52f{package-name}，解析 JSON 响应，检查是否存在非空字符串的 readme 字段：

   $package = 'npm';
   $url = "https://www.php.cn/link/f3a22d6edd297a48ac3189878051a52f$package";
   $response = file_get_contents($url);
   $data = json_decode($response, true);
   
   if (isset($data['readme']) && trim($data['readme'])) {
       echo "✅ 成功获取内嵌 README：/n" . substr($data['readme'], 0, 200) . ".../n";
       exit;
   }

2. 备选：通过 GitHub API 拉取仓库 README
   若 readme 缺失，则提取 repository.url（通常形如 https://github.com/owner/repo），标准化为 GitHub API 路径，并调用 GET /repos/{owner}/{repo}/readme：

   if (isset($data['repository']['url'])) {
       $repoUrl = $data['repository']['url'];
       // 提取 owner/repo（支持 git+ssh、git+https、https 等格式）
       if (preg_match('#github/.com[/:]([^/]+)/([^/.]+)#i', $repoUrl, $matches)) {
           [$_, $owner, $repo] = $matches;
           $ghApiUrl = "https://api.github.com/repos/$owner/$repo/readme";
   
           $opts = [
               'http' => ['header' => "User-Agent: PHP-NPM-README-Fetcher/r/n"],
               'ssl' => ['verify_peer' => false] // 生产环境请启用证书验证
           ];
           $context = stream_context_create($opts);
           $ghResponse = file_get_contents($ghApiUrl, false, $context);
           $ghData = json_decode($ghResponse, true);
   
           if (isset($ghData['content'])) {
               $readmeContent = base64_decode($ghData['content']);
               echo "✅ 通过 GitHub API 获取 README（Base64 解码后）：/n" . 
                    substr($readmeContent, 0, 200) . ".../n";
               exit;
           }
       }
   }

⚠️ 注意事项：

PicWish

推荐！专业的AI抠图修图，支持格式转化

下载

• GitHub API 调用受速率限制（未认证用户约 60 次/小时），建议添加缓存（如 Redis）并考虑使用 Personal Access Token 提升限额；
• repository.url 可能为空或指向非 GitHub 平台（如 GitLab、Bitbucket），需额外判断；
• README 在 GitHub 返回的是 Base64 编码的原始文件内容，若需渲染 HTML，应使用 marked、commonmark 等库转换；
• 避免对同一包高频轮询，尊重各 API 的 RateLimit-Limit 和 Retry-After 响应头。

综上，没有单一“万能 API”，但组合使用 npm registry + GitHub API 可覆盖绝大多数主流包。关键在于优雅降级与错误处理，而非强依赖某一种来源。

https://www.php.cn/faq/1988524.html