社区指标的 REST API 端点

获取社区配置文件指标

返回存储库的所有社区配置文件指标。该存储库不能是分支。

返回的指标包括整体健康评分、存储库描述、文档是否存在、检测到的行为准则、检测到的许可证以及 ISSUE_TEMPLATE、PULL_REQUEST_TEMPLATE、README 和 CONTRIBUTING 文件是否存在。

health_percentage 分数定义为推荐的社区健康文件中有多少个的百分比。有关更多信息，请参阅“关于公共存储库的社区配置文件”。

content_reports_enabled 仅对组织拥有的存储库返回。

“获取社区配置文件指标”的细粒度访问令牌

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

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

“内容”存储库权限（读取）

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

“获取社区配置文件指标”的参数

标头
名称、类型、描述
`accept` 字符串建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` 字符串必需存储库的帐户所有者。名称不区分大小写。
`repo` 字符串必需不带 `.git` 扩展名的存储库名称。名称不区分大小写。

“获取社区配置文件指标”的 HTTP 响应状态代码

状态代码	描述
`200`	OK

“获取社区概况指标”的代码示例

请求示例

get/repos/{owner}/{repo}/community/profile

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/community/profile

响应

状态：200

{ "health_percentage": 100, "description": "我在 GitHub 上的第一个存储库！", "documentation": null, "files": { "code_of_conduct": { "name": "贡献者契约", "key": "contributor_covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" }, "code_of_conduct_file": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md", "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" }, "contributing": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING", "html_url": "https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING" }, "issue_template": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE", "html_url": "https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE" }, "pull_request_template": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE", "html_url": "https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE" }, "license": { "name": "MIT 许可证", "key": "mit", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "html_url": "https://github.com/octocat/Hello-World/blob/master/LICENSE", "node_id": "MDc6TGljZW5zZW1pdA==" }, "readme": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/README.md", "html_url": "https://github.com/octocat/Hello-World/blob/master/README.md" } }, "updated_at": "2017-02-28T19:09:29Z", "content_reports_enabled": true }