REST API 现在已版本化。 有关更多信息，请参阅“关于 API 版本控制”。

依赖项审查的 REST API 端点

使用 REST API 与依赖项更改进行交互。

关于依赖项审查

您可以使用 REST API 查看依赖项更改以及这些更改对安全性的影响，然后再将它们添加到您的环境中。您可以查看存储库的两个提交之间的依赖项差异，包括任何具有已知漏洞的版本更新的漏洞数据。有关依赖项审查的更多信息，请参阅“关于依赖项审查”。

获取两个提交之间的依赖项差异

获取存储库的两个提交之间的依赖项更改差异，基于在这些提交中对依赖项清单所做的更改。

用于“获取两个提交之间的依赖项差异”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "内容" 存储库权限（读取） 和 "拉取请求" 存储库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

用于“获取两个提交之间的依赖项差异”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

存储库的名称，不包括 .git 扩展名。名称不区分大小写。

basehead string 必需

要比较的基线和头部 Git 修订版。Git 修订版将解析为提交 SHA。命名修订版将解析为其相应的 HEAD 提交，并将确定适当的合并基线。此参数期望格式为 {base}...{head}。

查询参数
name string

相对于存储库根目录的依赖项清单文件的完整路径。

用于“获取两个提交之间的依赖项差异”的 HTTP 响应状态代码

状态码描述
200

正常

403

如果此仓库未启用 GitHub 高级安全功能，则会返回此响应

404

资源未找到

"获取提交之间依赖项的差异" 代码示例

请求示例

get/repos/{owner}/{repo}/dependency-graph/compare/{basehead}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/dependency-graph/compare/BASEHEAD

响应

状态: 200
[ { "change_type": "removed", "manifest": "package.json", "ecosystem": "npm", "name": "helmet", "version": "4.6.0", "package_url": "pkg:npm/[email protected]", "license": "MIT", "source_repository_url": "https://github.com/helmetjs/helmet", "vulnerabilities": [] }, { "change_type": "added", "manifest": "package.json", "ecosystem": "npm", "name": "helmet", "version": "5.0.0", "package_url": "pkg:npm/[email protected]", "license": "MIT", "source_repository_url": "https://github.com/helmetjs/helmet", "vulnerabilities": [] }, { "change_type": "added", "manifest": "Gemfile", "ecosystem": "rubygems", "name": "ruby-openid", "version": "2.7.0", "package_url": "pkg:gem/[email protected]", "license": null, "source_repository_url": "https://github.com/openid/ruby-openid", "vulnerabilities": [ { "severity": "critical", "advisory_ghsa_id": "GHSA-fqfj-cmh6-hj49", "advisory_summary": "Ruby OpenID", "advisory_url": "https://github.com/advisories/GHSA-fqfj-cmh6-hj49" } ] } ]