搜索

Enterprise Cloud

Enterprise Server

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

在 GitHub 旅程中随时为你提供帮助。

可以是以下选项之一

名称

所有 {{ name }} 指南

{{ name }} 学习路径

操作

输入搜索词以在 GitHub 文档中找到它。

搜索 - GitHub 文档

使用 REST API 在 GitHub 上搜索特定项。

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

快速入门

关于 GitHub 的 API

REST API 中的资源

API 版本

媒体类型

身份验证

确保 API 凭据安全

故障排除

OpenAPI 描述

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

细化 PAT 的终结点

GitHub 应用的权限

细化 PAT 的权限

重大更改

概述

使用 API

使用 JavaScript 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

分页

构建 CI 服务器

集成者最佳做法

入门 - Git 数据库

开始 - 检查

Guides

Artifacts

缓存

OIDC

权限

机密

自托管运行程序

变量

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub 应用

安装

市场

OAuth 授权

Webhook

应用

计费

分支

受保护的分支

检查运行

检查套件

检查

行为准则

Codes of conduct

代码扫描

Codespaces

组织

组织机密

存储库机密

用户机密

协作者

邀请

提交

提交注释

提交状态

Copilot for Business

Copilot

警报

Dependabot

依赖项检查

依赖项提交

软件材料清单 (SBOM)

依赖项关系图

部署密钥

部署分支策略

部署

环境

保护规则

部署状态

表情符号

Gists

注释

Blob

reference

标记

Trees

Git 数据库

Gitignore

存储库

用户

交互

问题

受理人

里程碑

时间线

许可证

Markdown

元数据

社区

统计信息

交通

指标

源导入

迁移

阻止用户

成员

外部协作者

个人访问令牌

规则

安全经理

Boards

卡片

Projects (classic)

拉取

评价注释

审查请求

审阅

速率限制

反应

发行版本

发布资产

自动链接

前叉

Git LFS

机密扫描

存储库安全公告

安全通知

Teams

讨论评论

讨论

电子邮件

关注者

GPG 密钥

Git SSH 密钥

SSH 签名密钥

社交帐户

存储库 Webhook 配置

存储库 Webhook 交付

存储库 Webhook

仓库 web 挂钩

classes.js

Searches for query terms inside of a file. This method returns up to 100 results <a href="https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination">per page</a>.
When searching for code, you can get text match metadata for the file content and file path fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/rest/reference/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find the definition of the <code>addClass</code> function inside <a href="https://github.com/jquery/jquery">jQuery</a> repository, your query would look something like this:
<code>q=addClass+in:file+language:js+repo:jquery/jquery</code>
This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.
Considerations for code search:
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
<ul>
<li>Only the default branch is considered. In most cases, this will be the <code>master</code> branch.</li>
<li>Only files smaller than 384 KB are searchable.</li>
<li>You must always include at least one search term when searching source code. For example, searching for <a href="https://github.com/search?utf8=%E2%9C%93&#x26;q=language%3Ago&#x26;type=Code"><code>language:go</code></a> is not valid, while <a href="https://github.com/search?utf8=%E2%9C%93&#x26;q=amazing+language%3Ago&#x26;type=Code"><code>amazing language:go</code></a> is.</li>
</ul>
This endpoint requires you to authenticate and limits you to 10 requests per minute.

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see <a href="https://docs.github.com/rest/reference/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/search-github/searching-on-github/searching-code">Searching code</a>" for a detailed list of qualifiers.

This field is deprecated. Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: <a href="https://docs.github.com/rest/reference/search#ranking-search-results">best match</a>

sort

This field is deprecated. Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.

order

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

Validation failed, or the endpoint has been spammed.

Search code

Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href="https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination">per page</a>.
When searching for commits, you can get text match metadata for the message field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/rest/reference/search#text-match-metadata">Text match
metadata</a>.
For example, if you want to find commits related to CSS in the <a href="https://github.com/octocat/Spoon-Knife">octocat/Spoon-Knife</a> repository. Your query would look something like this:
<code>q=repo:octocat/Spoon-Knife+css</code>

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see <a href="https://docs.github.com/rest/reference/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/search-github/searching-on-github/searching-commits">Searching commits</a>" for a detailed list of qualifiers.

Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href="https://docs.github.com/rest/reference/search#ranking-search-results">best match</a>

Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.

Search commits

Line Number Indexes Beyond 20 Not Displayed

Find issues by state and keyword. This method returns up to 100 results <a href="https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination">per page</a>.
When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted
search results, see <a href="https://docs.github.com/rest/reference/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
<code>q=windows+label:bug+language:python+state:open&#x26;sort=created&#x26;order=asc</code>
This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see "<a href="https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests">Searching only issues or pull requests</a>."

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see <a href="https://docs.github.com/rest/reference/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests">Searching issues and pull requests</a>" for a detailed list of qualifiers.

Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href="https://docs.github.com/rest/reference/search#ranking-search-results">best match</a>

Search issues and pull requests

enhancement

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href="https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination">per page</a>.
When searching for labels, you can get text match metadata for the label name and description fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/rest/reference/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:
<code>q=bug+defect+enhancement&#x26;repository_id=64778136</code>
The labels that best match the query appear first in the search results.

repository_id

Search labels