首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >数据鱼API「Git 忽略规则生成」接口手册

数据鱼API「Git 忽略规则生成」接口手册

原创
作者头像
用户12862874
发布于 2026-11-21 21:29:47
发布于 2026-11-21 21:29:47
140
举报

接口简介

「Git 忽略规则生成」是数据鱼API平台提供的 .gitignore 拼装工具接口,Base 路径 /api/git-ignore,共 4 个端点:健康检查、版本信息,以及 GET 与 POST 两种形态的运行端点。

数据鱼API 的这个接口内置 10 套模板:node、python、go、java、c++、rust、laravel、macos、windows、vscode。调用方给出技术栈清单,接口按顺序把命中模板的规则块拼成一段文本,再可选追加通用规则,最后返回可直接写进 .gitignore 的内容与元信息。

运行端点有两种模式:generate(默认)按 types 拼装,list 返回支持的模板名清单。types 用小写逗号分隔,模板名不区分大小写,未识别的名称不会报错,而是被收进 metadata.not_found,因此拼错技术栈名时会静默跳过,只留下一条元信息。

返回的 gitignore 字段已去掉首尾空白,metadata.included 记录实际命中的模板,not_found 记录未识别的项,size_bytes 是拼装过程中的字节数。它与返回字符串的长度可能相差几个字节,差值是末尾被裁掉的换行。

端点总览

方法

路径

说明

鉴权

GET

/api/git-ignore/ping

健康检查,返回服务器时间

需要

GET

/api/git-ignore/stats

版本信息

需要

POST

/api/git-ignore/run

生成规则(请求体)

需要

GET

/api/git-ignore/run

生成规则(查询串)

需要

通用约定

鉴权沿用数据鱼API 全站规则:X-API-Key 请求头或 ?api_key= 查询参数,缺失 4011、无效 4013。响应统一为 {code, msg, data},code 为 0 表示成功。

这个接口与多数接口有两处不同:ping 只返回时间、不含版本号,版本号需要 stats 取;业务端点名为 run,不是常见的 generate,路径写错会得到 4040。

GET 与 POST 的参数名一致,POST 支持 JSON 请求体与表单。types 在查询串里可以直接写 node,python,在 JSON 里既可以写成字符串也可以写成数组,两种形态都会被按逗号拆开处理。

核心端点详解

运行端点(run)

按模式分发:generate 拼装规则,list 返回模板清单。

参数

类型

必填

默认

说明

mode

string

否

generate

取 generate 或 list,其余值按 generate 处理

types

string

否

node,vscode

模板名,逗号分隔,不区分大小写

common

bool

否

true

是否追加 .env、.log、*.tmp 三条通用规则

generate 模式下,命中模板会输出以 ### 模板名 ### 开头的规则块,块与块之间空一行;list 模式忽略其它参数,直接返回 supported_types 与 total。

common 有一个容易踩的坑:判定用的是 PHP 的真值语义,字符串 "false" 与 "0" 里只有 "0" 为假,"false" 仍会追加通用规则。要关闭通用规则,应该省略该参数并显式传布尔 false,或传 0。

代码语言:javascript
复制
POST /api/git-ignore/run
Content-Type: application/json

{"types": "node,python,docker", "common": true}

上例中 docker 不在模板清单里,不会让请求失败,它会出现在 metadata.not_found,metadata.included 则是 ["node","python"]。

模板清单(list 模式)

同一端点切换 mode=list 即可拿到支持的模板名,适合在前端做多选框。

代码语言:javascript
复制
GET /api/git-ignore/run?mode=list

返回 data.supported_types 为 10 个模板键的有序数组,data.total 为 10。模板键与 10 套规则一一对应,没有隐藏别名,cpp 不算有效值,必须写 c++。

数据与限制

  • 模板共 10 套,覆盖 node、python、go、java、c++、rust、laravel、macos、windows、vscode。
  • 每个模板的规则条数不等,go 与 laravel 的模板带注释行,输出里会保留注释。
  • 未识别模板不报错,只记入 not_found;若全部未识别且关闭通用规则,gitignore 会返回空串。
  • 通用规则固定为 .env、.log、*.tmp 三条,开启时才追加。
  • size_bytes 按拼装内容计算,包含尾部换行,与返回的 gitignore 长度可能不一致。
  • 接口不做文件写入,也不校验目标仓库是否已有 .gitignore,同名文件的合并与去重需调用方自行处理。

典型使用场景

  • 脚手架初始化项目时把技术栈清单发给 run,直接落盘生成 .gitignore。
  • 多语言 monorepo 按子目录的栈分别生成规则块,再由构建脚本拼接。
  • 前端配置页用 mode=list 渲染模板多选,用户勾选后即时预览生成结果。
  • 代码审阅工具批量检查仓库的 .gitignore 是否漏掉语言相关规则。

注意事项

  • types 的默认值是 node,vscode 两个模板,文档示例里写的是单个 node,不传参时会多出一块 vscode 规则。
  • 文档把 types 的示例值写成 A,MX 这类与内置模板无关的名称,照抄只会得到空的 included。
  • stats 只返回 version 字段,ping 只返回 time 字段,两个端点的返回结构不互补,别指望 ping 带版本。
  • common 用字符串 "false" 关闭无效,仍会追加通用规则;关闭时用布尔 false 或 0。
  • 模板内容是固定的静态规则,不含项目特有的路径与密钥文件;生产项目仍需补充自己的忽略项。
  • 生成的规则仅覆盖常见语言与编辑器产物,是否适用于具体项目需自行复核,仓库安全策略与密钥管理不能依赖本接口。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

目录
  • 接口简介
  • 端点总览
  • 通用约定
  • 核心端点详解
    • 运行端点(run)
    • 模板清单(list 模式)
  • 数据与限制
  • 典型使用场景
  • 注意事项
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档