VicroCode 鬼斧神工 / API 工具
二维码生成器
输入一段文本就能生成相应的二维码,返回base64图片
工具截图
工具说明
# 二维码生成器工具说明
## 1. 工具简介
**二维码生成器**用于将输入的文本、网址或其他字符串内容生成对应的二维码图片。
工具接收一个字符串字段 `text`,并返回一个 **SVG 格式二维码的 Base64 Data URL**。返回结果可以直接作为网页、图片组件或前端页面中的图片地址使用。
---
## 2. 适用场景
该工具适合用于以下场景:
### 2.1 网址二维码生成
将网页链接、活动链接、表单链接等生成二维码,方便用户扫码访问。
示例:
```json
{
"text": "https://example.com"
}
```
---
### 2.2 文本内容二维码生成
将普通文本、说明文字、编号、验证码等内容编码为二维码。
示例:
```json
{
"text": "欢迎使用二维码生成器"
}
```
---
### 2.3 业务信息快速分享
适用于生成订单号、设备编号、邀请码、联系方式等业务信息二维码。
示例:
```json
{
"text": "ORDER-20240816-0001"
}
```
---
### 2.4 前端页面直接展示二维码
工具返回的是 Base64 Data URL,可直接用于 HTML 图片标签或前端图片组件中。
示例:
```html
<img src="data:image/svg+xml;base64,..." alt="二维码">
```
---
## 3. 输入说明
### 输入格式
工具输入必须是一个 JSON 对象。
### 输入字段
| 字段名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| `text` | string | 是 | 需要编码到二维码中的文本、网址或其他字符串 |
### 输入示例
```json
{
"text": "https://example.com"
}
```
---
## 4. 输出说明
### 输出格式
工具返回一个 JSON 对象。
### 输出字段
| 字段名 | 类型 | 说明 |
|---|---|---|
| `output` | string | SVG 格式二维码的 Base64 Data URL |
### 输出示例
```json
{
"output": "data:image/svg+xml;base64,..."
}
```
其中,`output` 可以直接作为图片地址使用。
---
## 5. 使用步骤
### 步骤 1:准备需要生成二维码的内容
确认要写入二维码的文本,例如:
```text
https://example.com
```
或:
```text
示例文本
```
---
### 步骤 2:按照 JSON 格式传入参数
请求内容示例:
```json
{
"text": "https://example.com"
}
```
注意:`text` 必须是字符串,且不能为空。
---
### 步骤 3:调用工具生成二维码
工具会根据 `text` 字段生成二维码,并返回 Base64 图片地址。
---
### 步骤 4:使用返回结果展示二维码
返回结果示例:
```json
{
"output": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0..."
}
```
可以在网页中这样使用:
```html
<img src="data:image/svg+xml;base64,PHN2ZyB4bWxucz0..." alt="二维码">
```
也可以将 `output` 传给支持图片地址的前端组件。
---
## 6. 工具限制
### 6.1 `text` 不能为空
如果传入空字符串,会报错。
错误示例:
```json
{
"text": ""
}
```
---
### 6.2 `text` 必须是字符串
不支持直接传入数字、数组、对象、布尔值等类型。
错误示例:
```json
{
"text": 123456
}
```
如需生成数字二维码,应将数字转换为字符串:
```json
{
"text": "123456"
}
```
---
### 6.3 输入内容不能超过二维码容量
二维码本身有容量限制。若输入文本过长,可能导致生成失败。
建议:
- 尽量输入简短内容;
- 如果是长文本,建议先生成短链接,再将短链接转换为二维码;
- 不建议直接将大段文章、长 JSON 或大量数据写入二维码。
---
### 6.4 输出格式固定为 SVG Base64 Data URL
工具返回的是 SVG 格式二维码,格式类似:
```text
data:image/svg+xml;base64,...
```
如果需要 PNG、JPG 等格式,需要额外转换。
---
### 6.5 二维码样式固定
当前二维码参数固定为:
| 参数 | 值 |
|---|---|
| 容错等级 | M |
| 模块尺寸 | 10 |
| 空白边框 | 4 |
暂不支持自定义颜色、Logo、尺寸、容错等级或边框大小。
---
### 6.6 不访问网络、不持久化数据
该工具只根据输入文本本地生成二维码:
- 不访问外部网络;
- 不写入文件;
- 不持久化保存输入文本;
- 不保存生成结果。
---
## 7. 常见错误说明
| 错误情况 | 原因 | 处理方式 |
|---|---|---|
| 输入不是 JSON 对象 | 请求格式错误 | 使用 JSON 对象作为输入 |
| `text` 缺失 | 未提供必填字段 | 添加 `text` 字段 |
| `text` 不是字符串 | 类型错误 | 将内容转为字符串 |
| `text` 为空 | 内容为空 | 填写非空文本 |
| 文本过长 | 超出二维码容量 | 缩短文本或使用短链接 |
---
## 8. 完整调用示例
### 请求
```json
{
"text": "https://example.com"
}
```
### 响应
```json
{
"output": "data:image/svg+xml;base64,..."
}
```
### HTML 展示
```html
<img src="data:image/svg+xml;base64,..." alt="二维码">
```
---
## 9. 推荐用法
为了获得更好的扫码体验,建议:
1. 生成网址二维码时使用完整 URL,例如 `https://example.com`;
2. 避免输入过长文本;
3. 如需编码复杂内容,优先使用短链接或简短标识符;
4. 将返回的 `output` 直接用于图片展示;
5. 在前端展示时为二维码添加合适的尺寸,例如:
```html
<img
src="返回结果中的 output"
alt="二维码"
style="width: 200px; height: 200px;"
>
```
调用地址
POST https://www.vicoco.cn/api/v1/tools/endpoint-30a49e5d/invoke/输入 JSON Schema
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"title": "二维码文本",
"example": "示例文本",
"description": "需要编码到二维码中的文本、网址或其他字符串。"
}
}
}输出 JSON Schema
{
"type": "object",
"required": [
"output"
],
"properties": {
"output": {
"type": "string",
"title": "二维码",
"example": "data:image/png;base64,...",
"description": "PNG 格式二维码的 Base64 Data URL,可直接作为图片地址使用。"
}
}
}