Search topics

GET

/search/topics

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See "Searching topics" for a detailed list of qualifiers.

When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field 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 search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

q=ruby+is:featured

This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

200 - 示例 1

{
    "incomplete_results": true,
    "items": [
        {
            "aliases": [
                {
                    "topic_relation": {
                        "id": 0,
                        "name": "string",
                        "relation_type": "string",
                        "topic_id": 0
                    }
                }
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "created_by": "string",
            "curated": true,
            "description": "string",
            "display_name": "string",
            "featured": true,
            "logo_url": "http://example.com",
            "name": "string",
            "related": [
                {
                    "topic_relation": {
                        "id": 0,
                        "name": "string",
                        "relation_type": "string",
                        "topic_id": 0
                    }
                }
            ],
            "released": "string",
            "repository_count": 0,
            "score": 0,
            "short_description": "string",
            "text_matches": [
                {
                    "fragment": "string",
                    "matches": [
                        {
                            "indices": [
                                0
                            ],
                            "text": "string"
                        }
                    ],
                    "object_type": "string",
                    "object_url": "string",
                    "property": "string"
                }
            ],
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "total_count": 0
}

请求参数

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.

返回响应

🟢200Response

application/json

Body

incomplete_results

boolean

必需

items

array[object (Topic Search Result Item) {16}]

必需

aliases

array [object {1}] | null

可选

created_at

string <date-time>

必需

created_by

string | null

必需

curated

boolean

必需

description

string | null

必需

display_name

string | null

必需

featured

boolean

必需

logo_url

string <uri> | null

可选

name

string

必需

array [object {1}] | null

可选

released

string | null

必需

repository_count

integer | null

可选

score

number

必需

short_description

string | null

必需

text_matches

array [object {5}]

可选

updated_at

string <date-time>

必需

total_count

integer

必需

🔵304304

🟠415415

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

Search repositories

Search users