Class SearchClient

java.lang.Object

ink.icoding.github4j.GithubClient

ink.icoding.github4j.client.SearchClient

public class SearchClient
extends GithubClient

GitHub Search API 客户端。

提供仓库、代码、提交、用户、Issue、标签、主题等的搜索功能。

对应 GitHub REST API 文档: Search

See Also:

• GithubClient

Constructor Summary

Constructors

Constructor	Description
SearchClient(GithubClient parent)

Method Summary

Modifier and Type	Method	Description
Page<Map<String,Object>>	searchCode(String query, SearchOptions options)	搜索代码。
Page<Commit>	searchCommits(String query, SearchOptions options)	搜索提交。
Page<Issue>	searchIssues(String query, SearchOptions options)	搜索 Issue 和 Pull Request。
Page<Label>	searchLabels(String query, String repo, SearchOptions options)	搜索仓库标签。
Page<Repository>	searchRepositories(String query, SearchOptions options)	搜索仓库。
Page<Map<String,Object>>	searchTopics(String query, SearchOptions options)	搜索主题。
Page<User>	searchUsers(String query, SearchOptions options)	搜索用户。

Methods inherited from class GithubClient

actions, builder, configureObjectMapper, delete, get, get, getPaged, getRaw, gists, git, issues, meta, notifications, orgs, patch, post, projects, pulls, put, putNoBody, releases, repos, search, teams, users, webhooks

Modifier and Type	Method	Description
ActionsClient	actions()
static GithubClientBuilder	builder()
protected com.fasterxml.jackson.databind.ObjectMapper	configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
protected GithubResponse<Void>	delete(String path)
protected <T> GithubResponse<T>	get(String path, com.fasterxml.jackson.core.type.TypeReference<T> typeRef, Map<String,String> queryParams)
protected <T> GithubResponse<T>	get(String path, Class<T> responseType, Map<String,String> queryParams)
protected <T> Page<T>	getPaged(String path, Class<T> itemType, Map<String,String> queryParams)
protected GithubResponse<byte[]>	getRaw(String path, Map<String,String> queryParams)
GistsClient	gists()
GitClient	git()
IssuesClient	issues()
MetaClient	meta()
NotificationsClient	notifications()
OrgsClient	orgs()
protected <T> GithubResponse<T>	patch(String path, Object body, Class<T> responseType)
protected <T> GithubResponse<T>	post(String path, Object body, Class<T> responseType)
ProjectsClient	projects()
PullRequestsClient	pulls()
protected <T> GithubResponse<T>	put(String path, Object body, Class<T> responseType)
protected GithubResponse<Void>	putNoBody(String path)
ReleasesClient	releases()
ReposClient	repos()
SearchClient	search()
TeamsClient	teams()
UsersClient	users()
WebhooksClient	webhooks()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SearchClient

public SearchClient(GithubClient parent)

Method Details

searchRepositories

public Page<Repository> searchRepositories(String query,
 SearchOptions options)

搜索仓库。

API 端点: GET /search/repositories

Parameters:

query - 搜索查询字符串

options - 搜索选项（排序、排序顺序、分页），可为 null

Returns:

分页的仓库搜索结果

searchCode

public Page<Map<String,Object>> searchCode(String query,
 SearchOptions options)

搜索代码。

API 端点: GET /search/code

Parameters:

query - 搜索查询字符串

options - 搜索选项（排序、排序顺序、分页），可为 null

Returns:

分页的代码搜索结果

searchCommits

public Page<Commit> searchCommits(String query,
 SearchOptions options)

搜索提交。

API 端点: GET /search/commits

Parameters:

query - 搜索查询字符串

options - 搜索选项（排序、排序顺序、分页），可为 null

Returns:

分页的提交搜索结果

searchUsers

public Page<User> searchUsers(String query,
 SearchOptions options)

搜索用户。

API 端点: GET /search/users

Parameters:

query - 搜索查询字符串

options - 搜索选项（排序、排序顺序、分页），可为 null

Returns:

分页的用户搜索结果

searchIssues

public Page<Issue> searchIssues(String query,
 SearchOptions options)

搜索 Issue 和 Pull Request。

API 端点: GET /search/issues

Parameters:

query - 搜索查询字符串

options - 搜索选项（排序、排序顺序、分页），可为 null

Returns:

分页的 Issue 搜索结果

searchLabels

public Page<Label> searchLabels(String query,
 String repo,
 SearchOptions options)

搜索仓库标签。

API 端点: GET /search/labels

Parameters:

query - 搜索查询字符串

repo - 仓库全名（格式: owner/repo）

options - 搜索选项（排序、排序顺序、分页），可为 null

Returns:

分页的标签搜索结果

searchTopics

public Page<Map<String,Object>> searchTopics(String query,
 SearchOptions options)

搜索主题。

API 端点: GET /search/topics

Parameters:

query - 搜索查询字符串

options - 搜索选项（排序、排序顺序、分页），可为 null

Returns:

分页的主题搜索结果