「gitignore 模板生成」是数据鱼API平台提供的忽略规则拼装接口,Base 路径 /api/gitignore-gen,共 3 个端点:健康检查、模板清单、生成规则。
数据鱼API 的这个接口内置 8 套模板:php、node、python、go、java、macos、windows、vscode。调用方按数组给出需要的模板,接口按数组顺序逐个拼接,每块以 ### 模板名 ### 开头,块间空一行,最终内容去掉首尾空白后返回。
每套模板的规则是固定的几条,不区分项目结构,也不做条件判断。php 模板是 vendor 目录、.env、composer.lock 与 phpunit.xml;node 是 node_modules 与两份日志加 .env;python 是 __pycache__、pyc、.venv 与 .env;go 是 bin、exe 与 vendor;java 是 class、jar、war、.gradle 与 build;macos 只有 .DS_Store;windows 是 Thumbs.db 与 desktop.ini;vscode 是 .vscode 目录。
返回体非常轻,data 里只有一个 content 字符串,没有行数、字节数、命中模板或未识别项之类的元信息。要判断哪些模板真的生效,调用方要么自己比对模板清单,要么检查返回内容里是否出现了对应的标题行。
方法 | 路径 | 说明 | 鉴权 |
|---|---|---|---|
GET | /api/gitignore-gen/ping | 健康检查,返回版本与时间 | 需要 |
GET | /api/gitignore-gen/list | 返回可用模板名数组 | 需要 |
POST | /api/gitignore-gen/generate | 按模板数组生成规则 | 需要 |
鉴权沿用数据鱼API 全站规则:X-API-Key 请求头或 ?api_key= 查询参数,缺失 4011、无效 4013。响应统一为 {code, msg, data}。
该接口只有一个业务参数 types,且必须是数组。缺省、空数组、传字符串都会得到 4001、msg 为 Invalid types array,不会退化成「返回全部模板」或「按逗号拆分」。这条约束是它与同类接口最大的差别,接入前先确认序列化方式。
JSON 请求体里写 {"types": ["php","node"]};表单提交要写成 types[]=php&types[]=node,写成 types=php,node 会被当成标量而报 4001。
返回 8 个模板名组成的字符串数组,顺序固定,可用于渲染多选控件。
GET /api/gitignore-gen/list文档把这个端点描述为「分页列表」,实际没有分页参数也不返回分页结构,data 直接就是数组。调用方不要按 data.list 去取值。
按传入的模板数组拼装忽略规则。
参数 | 类型 | 必填 | 默认 | 说明 |
|---|---|---|---|---|
types | array | 是 | — | 模板名数组,元素不区分大小写,未知名称被忽略 |
处理顺序与数组顺序一致,同一模板重复传入会出现两次规则块,接口不做去重。元素先转小写再查表,所以 PHP、Php 都能命中 php 模板;不在表内的名称直接跳过,不报错、不提示。
全部元素都未命中时,content 返回空串,code 仍为 0。这种「成功但为空」的结果需要在客户端单独判断,不能当作生成成功直接写文件。
POST /api/gitignore-gen/generate
Content-Type: application/json
{"types": ["php", "node", "vscode"]}上例返回三段规则块,按 php、node、vscode 的顺序排列,段标题分别是 ### PHP ###、### NODE ###、### VSCODE ###。
types 必须是数组,空数组与字符串都返回 4001。content 已去掉首尾空白,末尾不带换行。.gitignore,一次写盘。list 渲染复选项,用户勾选后调 generate 实时预览。content 直接渲染成代码块。types 的类型写成 string、说明写成「源码未限定取值范围」,实际必须是 JSON 数组或表单数组,传逗号分隔字符串会直接 4001。generate 只注册了 POST,用 GET 访问会得到 4050(方法不允许)。list 称为「分页列表」,实际返回的是模板名数组,没有分页字段。types 中的名称不会报错,只会得到更短的 content;建议先与 list 的返回值做一次比对。.idea、node 模板不含 .next,生产项目仍需按实际情况补充。原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。