Your first PDF.
"}' \ - -o output.pdf +npm install +npm run build +API_KEYS=your-key-here npm start ``` -## API Endpoints +## Endpoints ### Convert HTML to PDF - ```bash -curl -X POST https://docfast.dev/v1/convert/html \ +curl -X POST http://localhost:3100/v1/convert/html \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ - -d '{"html": "World
"}' \ -o output.pdf ``` ### Convert Markdown to PDF - ```bash -curl -X POST https://docfast.dev/v1/convert/markdown \ +curl -X POST http://localhost:3100/v1/convert/markdown \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ - -d '{"markdown": "# Hello\n\nWorld", "css": "body { font-family: sans-serif; }"}' \ - -o output.pdf -``` - -### Convert URL to PDF - -```bash -curl -X POST https://docfast.dev/v1/convert/url \ - -H "Authorization: Bearer YOUR_KEY" \ - -H "Content-Type: application/json" \ - -d '{"url": "https://example.com", "format": "A4", "landscape": true}' \ + -d '{"markdown": "# Hello\n\nWorld"}' \ -o output.pdf ``` ### Invoice Template - ```bash -curl -X POST https://docfast.dev/v1/templates/invoice/render \ +curl -X POST http://localhost:3100/v1/templates/invoice/render \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ @@ -73,95 +40,23 @@ curl -X POST https://docfast.dev/v1/templates/invoice/render \ "date": "2026-02-14", "from": {"name": "Your Company", "email": "you@example.com"}, "to": {"name": "Client", "email": "client@example.com"}, - "items": [{"description": "Consulting", "quantity": 10, "unitPrice": 150, "taxRate": 20}] + "items": [{"description": "Service", "quantity": 1, "unitPrice": 100, "taxRate": 20}] }' \ -o invoice.pdf ``` -### Demo (No Auth Required) +### Options +- `format`: Paper size (A4, Letter, Legal, etc.) +- `landscape`: true/false +- `margin`: `{top, right, bottom, left}` in CSS units +- `css`: Custom CSS (for markdown/html fragments) +- `filename`: Suggested filename in Content-Disposition header -Try the API without signing up: +## Auth +Pass API key via `Authorization: BearerNo API key needed.
"}' \ - -o demo.pdf +docker build -t docfast . +docker run -p 3100:3100 -e API_KEYS=your-key docfast ``` - -Demo PDFs include a watermark and are rate-limited. - -## PDF Options - -All conversion endpoints accept these options: - -| Option | Type | Default | Description | -|--------|------|---------|-------------| -| `format` | string | `"A4"` | Paper size: A4, Letter, Legal, A3, etc. | -| `landscape` | boolean | `false` | Landscape orientation | -| `margin` | object | `{top:"0",right:"0",bottom:"0",left:"0"}` | Margins in CSS units (px, mm, in, cm) | -| `printBackground` | boolean | `true` | Include background colors/images | -| `filename` | string | `"document.pdf"` | Suggested filename in Content-Disposition | -| `css` | string | — | Custom CSS (for HTML fragments and Markdown) | -| `scale` | number | `1` | Scale (0.1–2.0) | -| `pageRanges` | string | — | Page ranges, e.g. `"1-3, 5"` | -| `width` | string | — | Custom page width (overrides format) | -| `height` | string | — | Custom page height (overrides format) | -| `headerTemplate` | string | — | HTML template for page header | -| `footerTemplate` | string | — | HTML template for page footer | -| `displayHeaderFooter` | boolean | `false` | Show header/footer | -| `preferCSSPageSize` | boolean | `false` | Use CSS `@page` size over format | - -## Authentication - -Pass your API key via either: -- `Authorization: Bearerhello
" }), - }); - expect(res.status).toBe(200); - const disposition = res.headers.get("content-disposition"); - expect(disposition).toContain('filename="document.pdf"'); - }); - it("rejects invalid protocol (ftp)", async () => { - const res = await fetch(`${BASE}/v1/convert/url`, { - method: "POST", - headers: { Authorization: "Bearer test-key", "Content-Type": "application/json" }, - body: JSON.stringify({ url: "ftp://example.com" }), - }); - expect(res.status).toBe(400); - const data = await res.json(); - expect(data.error).toContain("http"); - }); - it("rejects invalid URL format", async () => { - const res = await fetch(`${BASE}/v1/convert/url`, { - method: "POST", - headers: { Authorization: "Bearer test-key", "Content-Type": "application/json" }, - body: JSON.stringify({ url: "not-a-url" }), - }); - expect(res.status).toBe(400); - const data = await res.json(); - expect(data.error).toContain("Invalid"); - }); - it("converts valid URL to PDF", async () => { - const res = await fetch(`${BASE}/v1/convert/url`, { - method: "POST", - headers: { Authorization: "Bearer test-key", "Content-Type": "application/json" }, - body: JSON.stringify({ url: "https://example.com" }), - }); - expect(res.status).toBe(200); - expect(res.headers.get("content-type")).toBe("application/pdf"); - const buf = await res.arrayBuffer(); - expect(buf.byteLength).toBeGreaterThan(10); - const header = new Uint8Array(buf.slice(0, 5)); - expect(String.fromCharCode(...header)).toBe("%PDF-"); - }); -}); -describe("Demo Endpoints", () => { - it("demo/html converts HTML to PDF without auth", async () => { - const res = await fetch(`${BASE}/v1/demo/html`, { - method: "POST", - headers: { "Content-Type": "application/json" }, - body: JSON.stringify({ html: "${message}
+${apiKey ? ` +