barcodes/templates/help.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>API Documentation</title>
</head>
<body>
    <h1>API Requests</h1>

    <p>API Requests can be made by making a POST request to /generate</p>

    <p>The request body should be JSON similar to the below</p>

    <pre>
        <code>
            {
                "barcode_type": "code128",
                "width": 600,
                "height": 100,
                "ecc_level": 4,
                "content": "45684562"
            }
        </code>
    </pre>

    <p><code>barcode_type</code> should be one of:</p>
    <ul>
        {{range .BarcodeOptions}}
        <li>{{.}}</li>
        {{end}}
    </ul>

    <p><code>width</code> and <code>height</code> are in pixels - PDF417 is a fixed size and these options will only change the canvas size.</p>

    <p><code>ecc_level</code> should be 1, 2, 3 or 4 where 1 is least resilient and 4 is most resilient</p>

    <p><code>content</code> should be the value you wish the barcode to display. This may not accept all characters - that is dependent on the barcode type.</p>

    <p>The response will be a PNG image</p>
</body>
</html>
Add initial 'help' page 2023-09-01 22:47:46 +01:00			`<!DOCTYPE html>`
			`<html lang="en">`
			`<head>`
			`<meta charset="UTF-8">`
			`<title>API Documentation</title>`
			`</head>`
			`<body>`
			`<h1>API Requests</h1>`

			`<p>API Requests can be made by making a POST request to /generate</p>`

			`<p>The request body should be JSON similar to the below</p>`

			`<pre>`
			`<code>`
			`{`
			`"barcode_type": "code128",`
			`"width": 600,`
			`"height": 100,`
			`"ecc_level": 4,`
			`"content": "45684562"`
			`}`
			`</code>`
			`</pre>`

			`<p><code>barcode_type</code> should be one of:</p>`
			`<ul>`
			`{{range .BarcodeOptions}}`
			`<li>{{.}}</li>`
			`{{end}}`
			`</ul>`

Update help page 2023-09-01 23:01:08 +01:00			`<p><code>width</code> and <code>height</code> are in pixels - PDF417 is a fixed size and these options will only change the canvas size.</p>`
Add initial 'help' page 2023-09-01 22:47:46 +01:00
			`<p><code>ecc_level</code> should be 1, 2, 3 or 4 where 1 is least resilient and 4 is most resilient</p>`

			`<p><code>content</code> should be the value you wish the barcode to display. This may not accept all characters - that is dependent on the barcode type.</p>`

			`<p>The response will be a PNG image</p>`
			`</body>`
			`</html>`