External/SnapOtter
1
0
Fork 0
mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: organize tool pages by modality under /tools/<modality>/

Browse Source 
Move all 157 tool pages into image/video/audio/pdf/data subfolders so URLs read /tools/<modality>/<id> (e.g. /tools/image/crop). Nest the image sub-categories under an Image group in the sidebar so the nav reads by modality. Add public/_redirects (301, clean + .html forms) mapping every old flat /tools/<id> URL to its new path so inbound links keep working. Rewrite all internal /tools links. Verified with a clean docs build (no dead links).
This commit is contained in:
SnapOtter
2026-06-18 14:12:28 +08:00
parent 03c1a5e36f
commit d24e244af4
162 changed files with 874 additions and 554 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/tools/image/qr-generate.md
+71
View File
@@ -0,0 +1,71 @@
---
description: Generate QR codes with custom colors and error correction levels.
---
# QR Code Generator
Generate QR code images from text or URLs with configurable size, error correction level, and custom foreground/background colors.
## API Endpoint
`POST /api/v1/tools/image/qr-generate`
Accepts a **JSON body** (not multipart). No file upload is needed.
## Parameters
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| text | string | Yes | - | Content to encode in the QR code (1 to 2000 characters) |
| size | number | No | `400` | Output image width/height in pixels (100 to 10000) |
| errorCorrection | string | No | `"M"` | Error correction level: `L` (7%), `M` (15%), `Q` (25%), `H` (30%) |
| foreground | string | No | `"#000000"` | QR code foreground/module color in hex (`#RRGGBB`) |
| background | string | No | `"#FFFFFF"` | QR code background color in hex (`#RRGGBB`) |
### Error Correction Levels
| Level | Recovery | Use Case |
|-------|----------|----------|
| `L` | ~7% | Maximum data density |
| `M` | ~15% | Balanced (default) |
| `Q` | ~25% | Good for printed codes |
| `H` | ~30% | Best for codes with logos overlay |
## Example Request
```bash
curl -X POST http://localhost:1349/api/v1/tools/image/qr-generate \
-H "Authorization: Bearer si_your-api-key" \
-H "Content-Type: application/json" \
-d '{"text": "https://snapotter.com", "size": 500, "errorCorrection": "H"}'
```
Branded QR code with custom colors:
```bash
curl -X POST http://localhost:1349/api/v1/tools/image/qr-generate \
-H "Authorization: Bearer si_your-api-key" \
-H "Content-Type: application/json" \
-d '{"text": "Hello World", "size": 300, "foreground": "#1a365d", "background": "#f7fafc"}'
```
## Example Response
```json
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/qrcode.png",
"originalSize": 0,
"processedSize": 4520
}
```
## Notes
- This endpoint accepts JSON, not multipart form data, since no image upload is needed.
- The output is always a PNG image.
- The output filename is always `qrcode.png`.
- `originalSize` is always 0 since this tool generates images from scratch.
- A 2-module quiet zone (margin) is included around the QR code.
- Maximum text length is 2000 characters. Actual capacity depends on error correction level and character encoding.
- Higher error correction levels allow the QR code to remain scannable even if partially obscured but reduce data capacity.