Class MetaClient

java.lang.Object

ink.icoding.github4j.GithubClient

ink.icoding.github4j.client.MetaClient

public class MetaClient
extends GithubClient

GitHub API 元数据客户端。

提供 API 根端点、服务器元信息、Octocat、Zen 等基础信息查询。

Constructor Summary

Constructors

Constructor	Description
MetaClient(GithubClient parent)

Method Summary

Modifier and Type	Method	Description
GithubResponse<Map<String,Object>>	getApiRoot()	获取 GitHub API 根端点信息。
GithubResponse<Map<String,Object>>	getMeta()	获取 GitHub 服务器元信息（IP 地址、已安装的钩子类型等）。
GithubResponse<String>	getOctocat(String s)	获取 Octocat ASCII 图案。
GithubResponse<Map<String,Object>>	getRateLimit()	获取当前 API 速率限制状态。
GithubResponse<String>	getZen()	获取一句 Zen of GitHub 语录。

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

MetaClient

public MetaClient(GithubClient parent)

Method Details

getApiRoot

public GithubResponse<Map<String,Object>> getApiRoot()

获取 GitHub API 根端点信息。

对应端点: GET /

Returns:

API 根端点的链接信息

getMeta

public GithubResponse<Map<String,Object>> getMeta()

获取 GitHub 服务器元信息（IP 地址、已安装的钩子类型等）。

对应端点: GET /meta

Returns:

服务器元信息，包含 hooks、web、api、git 等 IP 段

getOctocat

public GithubResponse<String> getOctocat(String s)

获取 Octocat ASCII 图案。

对应端点: GET /octocat

Parameters:

s - 可选的自定义消息（显示在 Octocat 旁边）

Returns:

Octocat ASCII 艺术字

getZen

public GithubResponse<String> getZen()

获取一句 Zen of GitHub 语录。

对应端点: GET /zen

Returns:

GitHub 的设计哲学语录

getRateLimit

public GithubResponse<Map<String,Object>> getRateLimit()

获取当前 API 速率限制状态。

对应端点: GET /rate_limit

返回 core、search、graphql、integration_manifest 等各类资源的限额信息。

Returns:

速率限制概览，包含各类资源的 limit、remaining、reset 时间