如何通过 API 获取 NPM 包的 README 内容（支持 PHP 实现）-php教程-PHP中文网

如何通过 API 获取 NPM 包的 README 内容（支持 PHP 实现）

本文详解如何在 php 中可靠获取 npm 包的 readme 文件：优先尝试 npm 官方 registry（部分包直接提供），对缺失 readme 的包则自动回退至 github/gitlab 等源码平台 api，附完整可运行示例与错误处理建议。

NPM 官方 registry（https://www.php.cn/link/f3a22d6edd297a48ac3189878051a52f）并非对所有包都返回 README 内容——它仅在包发布时将 README.md 作为字段嵌入到 package.json 同级的元数据中（即响应中的 readme 字段）。例如 npm 包的响应包含该字段，而 react 则不包含（尽管其 GitHub 仓库存在 README）。因此，单纯依赖 registry 会导致大量失败。

✅ 推荐策略：两级回退机制

第一级：请求 npm registry 获取 readme 字段
若响应中存在非空 readme 字段，直接使用；
第二级：解析 repository.url，调用对应 Git 平台 API
- GitHub：使用 GET /repos/{owner}/{repo}/readme（需处理 base64 解码）
- GitLab：类似路径（/api/v4/projects/{id}/repository/files/README%2Emd/raw）
- 其他（如 Bitbucket）需适配对应 API

以下为 PHP 实现示例（含错误处理与自动解码）：

Upstream Recon

在与开源项目（如提交PR、Issue或评论）互动前，先对其进行调研。适用于：提交Issue、提交PR或发表评论之前。

下载

<?php function getPackageReadme(string $packageName): ?string
{
    // Step 1: Try npm registry
    $registryUrl = "https://www.php.cn/link/f3a22d6edd297a48ac3189878051a52f$packageName";
    $registryData = @json_decode(file_get_contents($registryUrl), true);

    if ($registryData && isset($registryData['readme']) && trim($registryData['readme']) !== '') {
        return trim($registryData['readme']);
    }

    // Step 2: Extract repository URL
    if (!isset($registryData['repository']['url'])) {
        throw new Exception("No repository URL found for package: $packageName");
    }

    $repoUrl = $registryData['repository']['url'];
    // Normalize git+https://github.com/user/repo.git → https://github.com/user/repo
    $repoUrl = preg_replace('/^(git\+)?(https?:\/\/)?(github\.com\/.+?)(\.git)?$/', 'https://$3', $repoUrl);

    // GitHub API fallback
    if (preg_match('#github\.com\/([^\/]+)\/([^\/]+)#i', $repoUrl, $matches)) {
        $owner = $matches[1];
        $repo  = $matches[2];
        $ghApiUrl = "https://api.github.com/repos/$owner/$repo/readme";

        $headers = ['User-Agent: PHP-NPM-Readme-Client'];
        $context = stream_context_create([
            'http' => [
                'method' => 'GET',
                'header' => implode("\r\n", $headers),
                'timeout' => 10,
            ]
        ]);

        $ghResponse = @file_get_contents($ghApiUrl, false, $context);
        if ($ghResponse === false) {
            throw new Exception("Failed to fetch README from GitHub for $owner/$repo");
        }

        $ghData = json_decode($ghResponse, true);
        if (isset($ghData['content']) && isset($ghData['encoding']) && $ghData['encoding'] === 'base64') {
            return base64_decode($ghData['content']);
        }
    }

    throw new Exception("Unable to retrieve README: no supported repository backend found.");
}

// Usage
try {
    $readme = getPackageReadme('lodash');
    echo substr($readme, 0, 200) . "..."; // 输出前200字符预览
} catch (Exception $e) {
    error_log("Readme fetch failed: " . $e->getMessage());
}
?>

⚠️ 注意事项：