Search code

GET

/search/code

Searches for query terms inside of a file. This method returns up to 100 results per page.

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

q=addClass+in:file+language:js+repo:jquery/jquery

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

Considerations for code search

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

Only the default branch is considered. In most cases, this will be the master branch.

Only files smaller than 384 KB are searchable.

You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while

amazing
language:go

is.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/search/code?q='

响应示例

200 - 示例 1

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

string

必需

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 GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.

sort

string

可选

Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: best match

order

string

可选

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

per_page

integer

可选

Results per page (max 100).

page

integer

可选

Page number of the results to fetch.

返回响应

🟢200Response

application/json

Body

incomplete_results

boolean

必需

items

array[object (Code Search Result Item) {13}]

必需

file_size

integer

可选

git_url

string <uri>

必需

html_url

string <uri>

必需

language

string | null

可选

last_modified_at

string <date-time>

可选

line_numbers

array[string]

可选

示例值:

["73..77","77..78"]

name

string

必需

path

string

必需

repository

object (Minimal Repository)

必需

Minimal Repository

score

number

必需

sha

string

必需

text_matches

array [object {5}]

可选

url

string <uri>

必需

total_count

integer

必需

🔵304304

🟠403403

🟠422422

🔴503503

修改于 2022-08-24 13:05:06

Update a pull request branch

Search commits

Search code

Considerations for code search#

请求参数

返回响应

Considerations for code search