Green-Wall API完全参考:开发者必看的接口调用指南

Green-Wall API完全参考:开发者必看的接口调用指南
Green-Wall API完全参考开发者必看的接口调用指南【免费下载链接】Green-Wall⬜ GitHub Contributions Graph Generator. :octocat:项目地址: https://gitcode.com/gh_mirrors/gr/Green-WallGreen-WallGitHub 加速计划是一款强大的 GitHub 贡献图生成工具提供了丰富的 API 接口帮助开发者轻松获取和处理 GitHub 相关数据。本文将详细介绍 Green-Wall 的核心 API 接口包括接口地址、请求参数、响应格式及实际调用示例帮助开发者快速集成 Green-Wall 功能到自己的应用中。快速入门API 调用基础Green-Wall 的 API 接口遵循 RESTful 设计规范所有接口均以/api为前缀支持标准的 HTTP 方法。在开始调用 API 之前建议先通过以下命令克隆项目到本地以便查看完整的接口实现代码git clone https://gitcode.com/gh_mirrors/gr/Green-Wall所有 API 接口的实现代码位于src/app/api目录下例如 AI 年度报告接口的实现文件为src/app/api/ai/yearly-report/route.ts。图Green-Wall 项目目录结构示意图API 接口主要位于 src/app/api 目录核心 API 接口详解1. 贡献数据获取接口接口地址/api/contribution/[username]请求方法GET功能描述获取指定 GitHub 用户的贡献数据包括贡献日历、统计信息等。请求参数username路径参数GitHub 用户名必填years查询参数指定年份多个年份用逗号分隔可选statistics查询参数是否返回统计数据布尔值可选响应示例{ data: { login: octocat, contributionYears: [2023, 2024, 2025], contributionCalendars: [...], statistics: { totalContributions: 1250, longestStreak: 45, maxDayCount: 28 } }, meta: { mode: public, fetchedAt: 2026-07-20T09:19:30Z } }实现代码src/app/api/contribution/[username]/route.ts2. 仓库分析接口接口地址/api/repo/[owner]/[repo]请求方法GET功能描述获取指定 GitHub 仓库的详细分析数据包括基本信息、健康指标、技术栈等。请求参数owner路径参数仓库所有者用户名必填repo路径参数仓库名称必填includeMetrics查询参数指定要返回的指标类型可选值为 basic、health、techstack多个值用逗号分隔默认值为 basic,health响应示例{ data: { name: Green-Wall, description: GitHub Contributions Graph Generator, owner: { login: gr }, healthMetrics: { codeQuality: 92, issueResolutionTime: 3.5, contributorCount: 15 }, techStack: [TypeScript, Next.js, React] }, meta: { mode: public, metrics: [basic, health, techstack] } }实现代码src/app/api/repo/[owner]/[repo]/route.ts3. AI 年度报告接口接口地址/api/ai/yearly-report请求方法POST功能描述生成指定用户的年度贡献 AI 分析报告支持流式响应。请求体参数{ username: octocat, year: 2025, locale: en, tags: { activity_level: high, commit_style: frequent, time_pattern: night_owl, tech_focus: frontend, repo_pattern: diverse }, highlights: { totalContributions: 1250, longestStreak: 45, maxDayCount: 28 }, aiConfig: { baseUrl: https://api.openai.com/v1, apiKey: your-api-key, model: gpt-4 } }响应格式采用 Server-Sent Events (SSE) 格式流式返回 AI 生成的报告内容。事件类型text报告文本片段done报告生成完成error发生错误实现代码src/app/api/ai/yearly-report/route.ts图Green-Wall AI 年度报告生成流程示意图高级功能批量数据获取1. 批量仓库数据接口接口地址/api/repos请求方法GET功能描述获取多个仓库的基本信息支持分页和筛选。请求参数page页码默认 1per_page每页数量默认 20sort排序方式可选值为 stars、forks、updatedlanguage按编程语言筛选可选2. 仓库交互数据接口接口地址/api/repo-interactions请求方法GET功能描述获取仓库的交互数据包括 issue、PR 等统计信息。请求参数owner仓库所有者必填repo仓库名称必填period时间范围可选值为 week、month、year默认 month错误处理与状态码Green-Wall API 使用标准的 HTTP 状态码表示请求结果200 OK请求成功400 Bad Request请求参数错误401 Unauthorized认证失败可能是 API Key 无效或缺失404 Not Found资源不存在可能是用户名或仓库名错误500 Internal Server Error服务器内部错误错误响应格式示例{ errorType: BadCredentials, message: Invalid API key }最佳实践与性能优化缓存策略对于频繁访问的公开数据建议在客户端实现缓存机制减少 API 请求次数。批量请求尽量使用批量接口获取数据减少 HTTP 请求数量。异步处理对于 AI 报告等耗时操作使用流式响应并在客户端实现异步处理。错误重试实现合理的错误重试机制特别是对于网络不稳定的情况。总结Green-Wall 提供了一系列强大的 API 接口帮助开发者轻松获取和处理 GitHub 数据。从基本的贡献数据到高级的 AI 分析报告这些接口涵盖了 GitHub 数据处理的各个方面。通过本文的指南您应该能够快速开始使用 Green-Wall API并将其集成到自己的应用中。如果您在使用过程中遇到任何问题可以查看项目中的详细文档或参考 API 实现代码也可以提交 issue 寻求帮助。祝您使用愉快图Green-Wall 功能展示展示了贡献图和 AI 分析报告界面【免费下载链接】Green-Wall⬜ GitHub Contributions Graph Generator. :octocat:项目地址: https://gitcode.com/gh_mirrors/gr/Green-Wall创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考