ToolJet GitHub Marketplace 插件使用指南连接 GitHub 数据源与执行仓库查询【免费下载链接】ToolJetOpen-source foundation of ToolJet AI - the enterprise app generation platform for internal tools, dashboards, business applications, workflows and AI agents. Build visually, from a prompt, or from Claude Code, Codex and Cursor over MCP 项目地址: https://gitcode.com/GitHub_Trending/to/ToolJetToolJet 通过官方 Marketplace 提供了 GitHub 数据源插件允许你在应用构建器中直接对接 GitHub读取用户信息、仓库详情、Issue 与 Pull Request 列表并将结果绑定到表格、图表等组件上快速搭建开发运维类内部工具。本文基于 GitHub 插件官方文档 与仓库中该插件的完整源码讲解连接配置、四种内置查询的参数细节以及底层基于 Octokit 的实现原理读完即可独立完成数据源接入与查询调优。插件概览从文档到源码GitHub 插件是 ToolJet Marketplace 生态中的一个type: api类型数据源插件完整的插件包位于 marketplace/plugins/github其核心结构如下lib/index.ts插件入口Github类实现QueryService接口负责建立连接、分发操作与测试连接lib/query_operations.ts四种查询操作的具体实现全部基于octokit客户端调用 GitHub REST APIlib/manifest.json数据源级配置 Schema定义认证方式与凭据字段lib/operations.json查询操作级 Schema定义操作下拉列表与各操作的参数表单lib/types.tsSourceOptions、QueryOptions与Operation枚举等类型定义package.json插件元信息核心运行时依赖为octokit ^4.0.2与tooljet-marketplace/common ^1.0.0。插件对外暴露四种查询能力与文档中的 Supported Queries 一一对应操作标识Operation对应 REST 端点get_user_infoGET /users/{username}get_repoGET /repos/{owner}/{repo}get_repo_issuesGET /repos/{owner}/{repo}/issuesget_repo_pull_requestsGET /repos/{owner}/{repo}/pulls建立连接Personal Access Token 认证凭据要求要连接 GitHub 数据源你只需要一种凭据Personal Access Token个人访问令牌可通过 GitHub 账号设置页面生成。生成令牌时请根据后续要执行的查询勾选合适的权限范围——仅读取公开数据时使用无权限的令牌即可访问私有仓库数据则需为令牌授予repo相关的读取权限。关于令牌的适用边界官方文档明确说明访问私有仓库的数据必须提供 Personal Access Token公开仓库的数据无需令牌即可访问。也就是说即使不配置令牌你依然可以查询公开仓库的信息但查询私有仓库时会因凭据不足而失败。凭据字段与加密存储从 manifest.json 可以看到数据源配置层的定义source: { name: GitHub, kind: github, exposedVariables: { isLoading: false, data: {}, rawData: {} }, options: { auth_type: { type: string }, personal_token: { type: string, encrypted: true } } }关键点auth_type认证类型标识默认值为personal_access_token当前仅支持这一种认证方式在界面中表现为Use Personal Access Token单选下拉personal_token令牌字段标记为encrypted: true意味着令牌会以加密形式存储界面输入框类型为passwordrequired: [personal_token]令牌是必填项数据源还对外暴露isLoading、data、rawData三个变量供查询运行时在应用内引用如表格加载态。底层连接与测试逻辑连接与测试逻辑实现在 lib/index.tsasync testConnection(sourceOptions: SourceOptions): PromiseConnectionTestResult { const octokit await this.getConnection(sourceOptions); try { const { status } await octokit.rest.users.getAuthenticated(); if (status) { return { status: ok }; } } catch (error) { return { status: failed, message: Invalid credentials }; } } async getConnection(sourceOptions: SourceOptions): Promiseany { const octokitClient new Octokit({ auth: sourceOptions.personal_token, }); return octokitClient; }getConnection使用personal_token创建Octokit实例testConnection调用 GitHub 的GET /useroctokit.rest.users.getAuthenticated()校验令牌有效性成功后返回status: ok令牌非法时返回status: failed与Invalid credentials提示。在界面上的操作路径为数据源 → 添加数据源 → 选择 GitHub → 粘贴 Personal Access Token → 点击测试连接 → 保存。下图展示了文档中的连接界面截图支持的四类查询操作详解以下四个查询即为该插件当前支持的全部操作。除Get User Info外其余三个操作共享Owner Repository的组合参数模式可配合状态过滤与分页参数灵活取数。Get User Info获取用户信息该操作用于获取指定 GitHub 用户或组织的详细信息如登录名、名称、头像、公共仓库数、粉丝数、个人主页、所在地、创建时间等。必填参数UsernameGitHub 用户名或组织名。底层调用 query_operations.ts 中的getUserInfoexport async function getUserInfo(octokit: Octokit, options: QueryOptions): Promiseobject { const { data } await octokit.request(GET /users/{username}, { username: options.username, }); return data; }对应 REST 端点为GET /users/{username}该端点支持匿名访问因此即使未配置令牌也能查询公开用户信息。界面截图参考文档配图Get Repository获取仓库详情获取指定仓库的详细元数据包括仓库描述、默认分支、Star 数、Fork 数、语言、许可证、是否私有、最近更新时间等。必填参数Owner仓库所有者名称可以是 GitHub 用户或组织Repository仓库的准确名称。底层调用getRepoexport async function getRepo(octokit: Octokit, options: QueryOptions): Promiseobject { const { data } await octokit.request(GET /repos/{owner}/{repo}, { owner: options.owner, repo: options.repo, }); return data; }Get Repository Issues获取仓库 Issue 列表生成指定仓库的 Issue 列表并支持按状态过滤。必填参数Owner仓库所有者名称用户或组织Repository要检索 Issue 的仓库名称State按状态过滤 Issue可选All全部/ Open打开/ Closed已关闭。可选参数Page size每页返回的 Issue 数量默认 30Page number要获取的页码默认 1。底层实现query_operations.tsexport async function getRepoIssues(octokit: Octokit, options: QueryOptions): Promiseobject { const { data } await octokit.request(GET /repos/{owner}/{repo}/issues, { owner: options.owner, repo: options.repo, state: options.state || all, ...(options.page validateNumber(The value must be greater than 1., page, options.page, 1) { page: parseInt(options.page, 10), }), ...(options.page_size validateNumber(The value must be in the range of 1 to 100, page size, options.page_size, 1, 100) { per_page: parseInt(options.page_size, 10), }), }); return data; }需要注意的几个实现细节state缺省值为all不填写状态时按全部状态查询分页参数仅在显式提供时才会传给 GitHub不传则使用 GitHub REST API 的默认分页行为参数校验page必须大于等于 1page_size对应 GitHub 的per_page必须在 1 到 100 之间超出范围会抛出形如Invalid page size: The value must be in the range of 1 to 100的校验错误——这也解释了为什么界面占位提示中把 100 作为上限。Get Repository Pull Requests获取仓库 Pull Request 列表生成指定仓库的 Pull Request 列表支持按状态过滤。必填参数Owner仓库所有者名称用户或组织Repository要检索 PR 的仓库名称State按状态过滤 PR可选All / Open / Closed。可选参数Page size每页返回的 PR 数量默认 30Page number要获取的页码默认 1。底层实现为getRepoPullRequests调用GET /repos/{owner}/{repo}/pulls其参数处理、缺省值与校验规则与getRepoIssues完全一致query_operations.ts。运行机制从操作分发到结果返回在 ToolJet 中执行一条 GitHub 查询时请求会进入 lib/index.ts 的run方法async run(sourceOptions: SourceOptions, queryOptions: QueryOptions, dataSourceId: string): PromiseQueryResult { const operation: Operation queryOptions.operation; const octokit: Octokit await this.getConnection(sourceOptions); let result {}; try { switch (operation) { case Operation.GetUserInfo: result await getUserInfo(octokit, queryOptions); break; case Operation.GetRepo: result await getRepo(octokit, queryOptions); break; case Operation.GetRepoIssues: result await getRepoIssues(octokit, queryOptions); break; case Operation.GetRepoPullRequests: result await getRepoPullRequests(octokit, queryOptions); break; default: throw new QueryError(Query could not be completed, Invalid operation, {}); } } catch (error) { throw new QueryError(Query could not be completed, error.message, {}); } return { status: ok, data: result }; }整个执行链路可以概括为三步建立客户端getConnection用令牌初始化 Octokit操作分发根据queryOptions.operation枚举定义见 lib/types.ts匹配四种操作之一未知操作会抛出Invalid operation统一封装结果成功时返回{ status: ok, data: result }失败时以QueryError包装错误信息方便在应用编辑器中定位问题。在应用中使用查询结果在 ToolJet 应用构建器中将 GitHub 数据源添加到应用后即可创建查询并选用上述四种操作。操作表单由 operations.json 驱动参数输入框类型为codehinter支持输入静态值也支持写表达式引用应用内其他组件/查询的返回值例如把表格选中行中的owner、repo动态传入查询参数state为下拉选择取值open/closed/all查询创建完成后可将其绑定到 Table、Listview 等展示组件data数组型结果按行渲染或用于触发后续查询如选中某条 Issue 后再查询其评论。以仓库 Issue 看板为例的典型用法Get repository issues查询传入固定的owner/repostate绑定下拉组件值page_size填 30结果绑定到表格组件即可在几分钟内搭出一个可筛选、可翻页的 Issue 列表视图。验证与扩展插件自带的测试入口位于tests/index.js目前为it.todo(needs tests)占位状态尚未补充针对run分发与参数校验的断言用例——若你打算为插件贡献测试validateNumber的边界条件page 1、page_size 100与state缺省值逻辑都是值得优先覆盖的路径。从扩展角度看该插件的操作集合固定为文档列出的四类。若需要读取 Issue 评论、仓库提交记录或触发 GitHub Actions 等更丰富的交互可在Operation枚举与run的switch分支中新增对应操作参照现有getRepoIssues的写法调用octokit.request并在 operations.json 中补充表单 Schema即可在界面上使用。小结GitHub 插件以极低的接入成本为 ToolJet 应用提供了访问 GitHub 数据的标准通道一个 Personal Access Token 即可建立连接四类内置查询覆盖了用户信息、仓库详情、Issue 与 PR 列表等高频场景且分页与状态过滤参数在源码层面有明确的缺省值与校验边界。本文所涉及的源码均可直接在仓库中查阅插件入口、查询操作实现、数据源 Schema 与 操作表单 Schema。【免费下载链接】ToolJetOpen-source foundation of ToolJet AI - the enterprise app generation platform for internal tools, dashboards, business applications, workflows and AI agents. Build visually, from a prompt, or from Claude Code, Codex and Cursor over MCP 项目地址: https://gitcode.com/GitHub_Trending/to/ToolJet创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考