「开源许可证查询」是数据鱼API平台提供的许可证要点速查接口,Base 路径 /api/license-lookup,共 2 个端点。调用方传入许可证标识,接口返回名称、允许的行为、需要满足的条件与责任限制三组要点,用于在依赖引入、代码分发或内部审查时快速核对条款轮廓。
当前支持的标识为 MIT、Apache-2.0 与 GPL-3.0,比较时不区分大小写。返回的 permissions、conditions、limitations 是英文短语数组,例如商业使用、修改、分发、专利授权、公开源码、保留版权声明等,属于条款摘要而非逐条译文。接口不返回许可证全文,也不判断多个许可证之间的兼容性。
数据鱼API把它设计成只读字典查询:没有状态、没有写入、没有调用记录。健康检查端点同时承担能力发现的作用,返回当前支持的标识列表,接入方可以在启动时缓存这份列表,避免把不受支持的标识发到业务请求里。
方法 | 路径 | 说明 | 鉴权 |
|---|---|---|---|
GET | /api/license-lookup/ping | 健康检查,返回支持的许可证标识列表 | 免鉴权 |
GET | /api/license-lookup/check | 按标识查询许可证要点 | 需要 Key |
鉴权使用平台统一 Key,通过 X-API-Key 请求头或 ?api_key= 查询参数传递;未携带返回 4011,无效返回 4013。响应统一为 code、msg、data,成功时 code 为 0。接口接受 GET 与 POST,POST 可用 JSON body 或表单,参数名与查询串一致。
错误码中,4001 表示缺少必填参数,4002 表示参数格式或取值非法,4003 表示取值不在支持列表,4004 表示查询目标未收录;4040 为路由不存在,4050 为方法不允许,5000、5001 为服务内部错误。数据鱼API对参数类错误与服务故障分开统计,前者通常重试无意义,应直接修正请求。
GET /api/license-lookup/ping 无参数、免鉴权,返回当前支持的许可证标识。它既可用于探活,也可用于能力发现。
参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
无 | — | — | — | 该端点不接受业务参数 |
响应 data 只有 supported_licenses 一个字段,值为字符串数组。当前内容为 MIT、Apache-2.0、GPL-3.0。与部分接口不同,这里的 msg 是 success 而非 pong,判断健康状态应以 code 为 0 为准。
GET /api/license-lookup/pingGET /api/license-lookup/check 按标识返回单个许可证的要点。
参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
id | string | 否 | — | 许可证标识,不区分大小写精确匹配 |
响应 data 含 name、permissions、conditions 与 limitations 四个字段,后三者为字符串数组。三个标识的要点对比如下:
标识 | permissions | conditions | limitations |
|---|---|---|---|
MIT | Commercial use、Modification、Distribution、Private use | License and copyright notice | Liability、Warranty |
Apache-2.0 | Commercial use、Modification、Distribution、Patent use、Private use | License and copyright notice、State changes | Liability、Trademark use、Warranty |
GPL-3.0 | Commercial use、Modification、Distribution、Patent use、Private use | Disclose source、License and copyright notice、Same license、State changes | Liability、Warranty |
GET /api/license-lookup/check?id=MIT&api_key=YOUR_KEY该例返回 MIT License,允许商业使用、修改、分发与私有使用,条件是保留许可证与版权声明,责任与担保被排除。
MIT、Apache-2.0、GPL-3.0 三个标识,大小写不敏感;建议调用前自行去除前后空格,再做比对。GPLv3、Apache 2.0、GPL-3.0-only 等常见写法都不会命中。permissions、conditions、limitations 是固定英文短语,顺序固定,不随语言参数变化。id 标为可选,但实现中该参数为空会直接返回 4001,应视为必填。4041 与 License not found,HTTP 状态为 404;该错误码不在通用错误表中,需要单独处理。GPL-3.0 返回 GNU GPLv3,不能据此判断是 only 还是 or later 版本。原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。