Skip to content

πŸ“‘ Document Generation as a REST service. It supports PDF Generation from LaTex and HTML templates.

Notifications You must be signed in to change notification settings

shuhanmirza/SimplePdfGenAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SimplePdfGenAPI

SimplePdfGenAPI is a PDF Generator REST Service that can be deployed out of the box. It can generate PDFs from LaTeX and HTML Templates. It supports variable setting and file/image embeddings.

Under the hood, it uses pdfLaTeX to create a PDF from LaTeX template. For generating PDFs from HTML templates it uses openhtmltopdf and Thymeleaf.

Getting Started

You can download the source code for SimplePdfGenAPI by running git clone github.com/shuhanmirza/SimplePdfGenAPI in your terminal.

After that, you can run docker-compose up --build.

SimplePdfGenAPI will run as an REST service by default on port 10800;

Generating PDFs

PDF's are generated by sending an HTTP POST request to the endpoint "/api/generate-pdf" with a JSON payload:

{
    "templateType": "LATEX | HTML", 
    "templateSourceType": "BASE64",
    "templateSource": "TEMPLATE_SOURCE",
    "stringMap": { KEY_VALUE_MAP },
    "listMap" : { KEY_LIST_MAP },
    "fileUrlMap": { KEY_FILE_MAP },
    "responseType": "JSON | OCTET_STREAM | PDF"
}

templateType

It denotes the type of the provided template. Currently, it supports LATEX and HTML.

templateSourceType

It denotes the type of source of the template. Currently, it only accepts the template string in BASE64 format.

templateSource

Source of the template.

For LaTeX, you have to put the variables between two % s, such as %FOOD%. SimplePdfGenAPI will replace the words denoted in such style with your desired values declared in stringMap and listMap. For embedding external files, you have to provide the file name and the source URL in the fileUrlMap.

For HTML, SimplePdfGenAPI uses Thymeleaf under the hood. So, you have to follow the notation of Thymeleaf and provide the values in stringMap and listMap.

stringMap

If your template has some single value variables, you can put the values of these variables as key-value map here.

listMap

Your template can have some variables that depict list values. You may need this if you are generating something like receipts. You can make put your lists here.

fileUrlMap

For LaTeX templates, you may need to embed an image into the PDF. You can add the URL of the image here. SimplePdfGenAPI downloads the files stated in fileUrlMap before compiling. You have to put the file's name in the key and the URL in the map's value.

For HTML templates, if you want to instruct the PDF generator to choose a specific font, you can add the URL to that here. You have to put the name of the font family in the key and the the the URL source of the .ttf file in the value of the map.

responseType

SimplePdfGenAPI can respond with three different media types; application/json, application/octet-stream, and application/pdf. You have to specify what is your desired media type here. Accepted values are JSON, OCTET_STREAM, and PDF. If you choose JSON, the pdf will be given encoded in base64.

Example

Generating a PDF from a latex template

See our example LaTex template in Doc/example.tex

You can see that, the variables are written between two % s.

\newcommand{\food}{%FOOD%}
\newcommand{\city}{%CITY%}
\newarray\CountryList
\newarray\CityList
\readarray{CountryList}{%COUNTRY_LIST%}
\readarray{CityList}{%CITY_LIST%}
\newcommand{\ListSize}{%LIST_SIZE%}

And the pdf has to embed an image file named universe.jpg

\vspace{1cm}
\includegraphics[scale=0.2]{universe.jpg}

Let's prepare the JSON payload.

First, encode the latex template to base64 by running:

cat example.tex | base64

Which gives the output:

XGRvY3VtZW50Y2xhc3NbYTRwYXBlciwxMXB0XXthcnRpY2xlfQpcdXNlcGFja2FnZXtncmFwaGljeH0KXHVzZXBhY2thZ2VbZW1wdHlde2Z1bGxwYWdlfQpcdXNlcGFja2FnZXtoeXBlcnJlZn0KXGh5cGVyc2V0dXB7CiAgICBjb2xvcmxpbmtzPXRydWUsCiAgICB1cmxjb2xvcj1ibHVlLAogICAgYnJlYWtsaW5rcz10cnVlCn0KXHVzZXBhY2thZ2V7YXJyYXlqb2J9Clx1c2VwYWNrYWdle211bHRpZG99CgpcbmV3Y29tbWFuZHtcZm9vZH17JUZPT0QlfQpcbmV3Y29tbWFuZHtcY2l0eX17JUNJVFklfQoKXG5ld2FycmF5XENvdW50cnlMaXN0ClxuZXdhcnJheVxDaXR5TGlzdAoKXHJlYWRhcnJheXtDb3VudHJ5TGlzdH17JUNPVU5UUllfTElTVCV9ClxyZWFkYXJyYXl7Q2l0eUxpc3R9eyVDSVRZX0xJU1QlfQpcbmV3Y29tbWFuZHtcTGlzdFNpemV9eyVMSVNUX1NJWkUlfQoKClx0aXRsZXtTcHJpbmdCb29UZXggRXhhbXBsZX0KXGRhdGV7fQpcYmVnaW57ZG9jdW1lbnR9CgpcbWFrZXRpdGxlCgpcc2VjdGlvbntTaW5nbGUgVmFyaWFibGV9CgpJIGFtIGZyb20gXGNpdHkuIEkgbG92ZSBlYXRpbmcgXGZvb2QuCgpcc2VjdGlvbntJbWFnZX0KVGhpcyBpbWFnZSB3YXMgZG93bmxvYWRlZCBmcm9tIFxocmVme2h0dHBzOi8vdXBsb2FkLndpa2ltZWRpYS5vcmcvd2lraXBlZGlhL2NvbW1vbnMvdGh1bWIvMi8yZi9IdWJibGVfdWx0cmFfZGVlcF9maWVsZC5qcGcvMTAyNHB4LUh1YmJsZV91bHRyYV9kZWVwX2ZpZWxkLmpwZ317V2lraXBlZGlhfQoKXHZzcGFjZXsxY219ClxpbmNsdWRlZ3JhcGhpY3Nbc2NhbGU9MC4yXXt1bml2ZXJzZS5qcGd9Cgpcc2VjdGlvbntBcnJheX0KCkxpc3Qgb2YgQ291bnRyaWVzIGFuZCB0aGVpciBDYXBpdGFscwoKXGJlZ2lue2l0ZW1pemV9CiAgICBcbXVsdGlkb3tcaT0xKzF9e1xMaXN0U2l6ZX17CiAgICAgICAgXGl0ZW0gXENvdW50cnlMaXN0KFxpKSA6IFxDaXR5TGlzdChcaSkKICAgIH0KXGVuZHtpdGVtaXplfQoKXGVuZHtkb2N1bWVudH0K

The JSON payload should look like this,

{
    "templateType": "LATEX",
    "templateSourceType": "BASE64",
    "templateSource": "XGRvY3VtZW50Y2xhc3NbYTRwYXBlciwxMXB0XXthcnRpY2xlfQpcdXNlcGFja2FnZXtncmFwaGljeH0KXHVzZXBhY2thZ2VbZW1wdHlde2Z1bGxwYWdlfQpcdXNlcGFja2FnZXtoeXBlcnJlZn0KXGh5cGVyc2V0dXB7CiAgICBjb2xvcmxpbmtzPXRydWUsCiAgICB1cmxjb2xvcj1ibHVlLAogICAgYnJlYWtsaW5rcz10cnVlCn0KXHVzZXBhY2thZ2V7YXJyYXlqb2J9Clx1c2VwYWNrYWdle211bHRpZG99CgpcbmV3Y29tbWFuZHtcZm9vZH17JUZPT0QlfQpcbmV3Y29tbWFuZHtcY2l0eX17JUNJVFklfQoKXG5ld2FycmF5XENvdW50cnlMaXN0ClxuZXdhcnJheVxDaXR5TGlzdAoKXHJlYWRhcnJheXtDb3VudHJ5TGlzdH17JUNPVU5UUllfTElTVCV9ClxyZWFkYXJyYXl7Q2l0eUxpc3R9eyVDSVRZX0xJU1QlfQpcbmV3Y29tbWFuZHtcTGlzdFNpemV9eyVMSVNUX1NJWkUlfQoKClx0aXRsZXtTcHJpbmdCb29UZXggRXhhbXBsZX0KXGRhdGV7fQpcYmVnaW57ZG9jdW1lbnR9CgpcbWFrZXRpdGxlCgpcc2VjdGlvbntTaW5nbGUgVmFyaWFibGV9CgpJIGFtIGZyb20gXGNpdHkuIEkgbG92ZSBlYXRpbmcgXGZvb2QuCgpcc2VjdGlvbntJbWFnZX0KVGhpcyBpbWFnZSB3YXMgZG93bmxvYWRlZCBmcm9tIFxocmVme2h0dHBzOi8vdXBsb2FkLndpa2ltZWRpYS5vcmcvd2lraXBlZGlhL2NvbW1vbnMvdGh1bWIvMi8yZi9IdWJibGVfdWx0cmFfZGVlcF9maWVsZC5qcGcvMTAyNHB4LUh1YmJsZV91bHRyYV9kZWVwX2ZpZWxkLmpwZ317V2lraXBlZGlhfQoKXHZzcGFjZXsxY219ClxpbmNsdWRlZ3JhcGhpY3Nbc2NhbGU9MC4yXXt1bml2ZXJzZS5qcGd9Cgpcc2VjdGlvbntBcnJheX0KCkxpc3Qgb2YgQ291bnRyaWVzIGFuZCB0aGVpciBDYXBpdGFscwoKXGJlZ2lue2l0ZW1pemV9CiAgICBcbXVsdGlkb3tcaT0xKzF9e1xMaXN0U2l6ZX17CiAgICAgICAgXGl0ZW0gXENvdW50cnlMaXN0KFxpKSA6IFxDaXR5TGlzdChcaSkKICAgIH0KXGVuZHtpdGVtaXplfQoKXGVuZHtkb2N1bWVudH0K",
    "stringMap": {
        "FOOD": "Birun Vaat",
        "CITY": "Sylhet",
        "LIST_SIZE": "3"
    },
    "listMap" : {
        "COUNTRY_LIST" : [
            "Bangladesh",
            "United States",
            "United Kingdom"
        ],
        "CITY_LIST" : [
            "Dhaka",
            "Washington DC",
            "London"
        ]
    },
    "fileUrlMap": {
        "universe.jpg": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/2f/Hubble_ultra_deep_field.jpg/1024px-Hubble_ultra_deep_field.jpg"
    },
    "responseType": "PDF"
}

And the generated PDF is
example-latex.pdf

At first, SimplePdfGenAPI downloads all the files mentioned in the fileUrlMap. Then, it puts the string and list variables mentioned in stringMap and listMap. Finally, it compiles the PDF using pdfLatex.

Example: Generating a PDF from an HTML template

See our example HTML template in Doc/example.html You can see that, the thymeleaf templating has been used in the template.

<tr th:each="service, serviceStat : ${serviceList}">
<td class="service" th:text="${serviceList.get(serviceStat.index)}"></td>
<td class="desc" th:text="${descriptionList.get(serviceStat.index)}"></td>
<td class="unit" th:text="${unitList.get(serviceStat.index)}"></td>
<td class="qty" th:text="${quantityList.get(serviceStat.index)}"></td>
<td class="total" th:text="${totalAmountList.get(serviceStat.index)}">$1</td>
</tr>
<tr>
<td colspan="4" class="sub">SUBTOTAL</td>
<td class="sub total" th:text="${subtotal}"></td>
</tr>

Like in the earlier example, you must encode the template to a base64 string and prepare a JSON payload.

{
    "templateType": "HTML",
    "templateSourceType": "BASE64",
    "templateSource": "<!-- thanks https://htmlpdfapi.com/blog/free_html5_invoice_templates-->
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="utf-8" />
    <title>Example HTML</title>
    <style>
        @font-face {
            font-family: Junge;
            src: url(https://s3-eu-west-1.amazonaws.com/htmlpdfapi.production/free_html5_invoice_templates/example3/Junge-Regular.ttf);
        }

        .clearfix:after {
            content: "";
            display: table;
            clear: both;
        }

        a {
            color: #001028;
            text-decoration: none;
        }

        @page {
            size: A4 portrait;
        }

        body {
            font-family: Junge;
            position: relative;
            margin: 0 auto;
            color: #001028;
            background: #FFFFFF;
            font-size: 14px;
        }

        .arrow {
            margin-bottom: 4px;
        }

        .arrow.back {
            text-align: right;
        }

        .inner-arrow {
            padding-right: 10px;
            height: 30px;
            display: inline-block;
            background-color: rgb(233, 125, 49);
            text-align: center;

            line-height: 30px;
            vertical-align: middle;
        }

        .arrow.back .inner-arrow {
            background-color: rgb(233, 217, 49);
            padding-right: 0;
            padding-left: 10px;
        }

        .arrow:before,
        .arrow:after {
            content: '';
            display: inline-block;
            width: 0;
            height: 0;
            border: 15px solid transparent;
            vertical-align: middle;
        }

        .arrow:before {
            border-top-color: rgb(233, 125, 49);
            border-bottom-color: rgb(233, 125, 49);
            border-right-color: rgb(233, 125, 49);
        }

        .arrow.back:before {
            border-top-color: transparent;
            border-bottom-color: transparent;
            border-right-color: rgb(233, 217, 49);
            border-left-color: transparent;
        }

        .arrow:after {
            border-left-color: rgb(233, 125, 49);
        }

        .arrow.back:after {
            border-left-color: rgb(233, 217, 49);
            border-top-color: rgb(233, 217, 49);
            border-bottom-color: rgb(233, 217, 49);
            border-right-color: transparent;
        }

        .arrow span {
            display: inline-block;
            width: 80px;
            margin-right: 20px;
            text-align: right;
        }

        .arrow.back span {
            margin-right: 0;
            margin-left: 20px;
            text-align: left;
        }

        h1 {
            color: #5D6975;
            font-family: Junge;
            font-size: 2.4em;
            line-height: 1.4em;
            font-weight: normal;
            text-align: center;
            border-top: 1px solid #5D6975;
            border-bottom: 1px solid #5D6975;
            margin: 0 0 2em 0;
        }

        h1 small {
            font-size: 0.45em;
            line-height: 1.5em;
            float: left;
        }

        h1 small:last-child {
            float: right;
        }

        #project {
            float: left;
        }

        #company {
            float: right;
        }

        table {
            width: 100%;
            border-collapse: collapse;
            border-spacing: 0;
            margin-bottom: 30px;
        }

        table th,
        table td {
            text-align: center;
        }

        table th {
            padding: 5px 20px;
            color: #5D6975;
            border-bottom: 1px solid #C1CED9;
            white-space: nowrap;
            font-weight: normal;
        }

        table .service,
        table .desc {
            text-align: left;
        }

        table td {
            padding: 20px;
            text-align: right;
        }

        table td.service,
        table td.desc {
            vertical-align: top;
        }

        table td.unit,
        table td.qty,
        table td.total {
            font-size: 1.2em;
        }

        table td.sub {
            border-top: 1px solid #C1CED9;
        }

        table td.grand {
            border-top: 1px solid #5D6975;
        }

        table tr:nth-child(2n-1) td {
            background: #EEEEEE;
        }

        table tr:last-child td {
            background: #DDDDDD;
        }

        #details {
            margin-bottom: 30px;
        }

        footer {
            color: #5D6975;
            width: 100%;
            height: 30px;
            position: absolute;
            bottom: 0;
            border-top: 1px solid #C1CED9;
            padding: 8px 0;
            text-align: center;
        }
    </style>
</head>

<body>
    <main>
        <h1 class="clearfix"><small><span>DATE</span><br /><span th:text="${date}"></span></small> <span
                th:text="${title}"></span> <small><span>DUE
                    DATE</span><br /><span th:text="${dueDate}"></span></small></h1>
        <table>
            <thead>
                <tr>
                    <th class="service">SERVICE</th>
                    <th class="desc">DESCRIPTION</th>
                    <th>PRICE</th>
                    <th>QTY</th>
                    <th>TOTAL</th>
                </tr>
            </thead>
            <tbody>
                <tr th:each="service, serviceStat : ${serviceList}">
                    <td class="service" th:text="${serviceList.get(serviceStat.index)}"></td>
                    <td class="desc" th:text="${descriptionList.get(serviceStat.index)}"></td>
                    <td class="unit" th:text="${unitList.get(serviceStat.index)}"></td>
                    <td class="qty" th:text="${quantityList.get(serviceStat.index)}"></td>
                    <td class="total" th:text="${totalAmountList.get(serviceStat.index)}">$1</td>
                </tr>

                <tr>
                    <td colspan="4" class="sub">SUBTOTAL</td>
                    <td class="sub total" th:text="${subtotal}"></td>
                </tr>
                <tr>
                    <td colspan="4" th:text="${taxTitle}"></td>
                    <td class="total" th:text="${taxAmount}"></td>
                </tr>
                <tr>
                    <td colspan="4" class="grand total">GRAND TOTAL</td>
                    <td class="grand total" th:text="${grandTotal}"></td>
                </tr>
            </tbody>
        </table>
        <div id="details" class="clearfix">
            <div id="project">
                <div class="arrow">
                    <div class="inner-arrow"><span>PROJECT</span> Website development</div>
                </div>
                <div class="arrow">
                    <div class="inner-arrow"><span>CLIENT</span> John Doe</div>
                </div>
                <div class="arrow">
                    <div class="inner-arrow"><span>ADDRESS</span> 796 Silver Harbour, TX 79273, US</div>
                </div>
                <div class="arrow">
                    <div class="inner-arrow"><span>EMAIL</span> <a href="mailto:john@example.com">john@example.com</a>
                    </div>
                </div>
            </div>
            <div id="company">
                <div class="arrow back">
                    <div class="inner-arrow">Company Name <span>COMPANY</span></div>
                </div>
                <div class="arrow back">
                    <div class="inner-arrow">455 Foggy Heights, AZ 85004, US <span>ADDRESS</span></div>
                </div>
                <div class="arrow back">
                    <div class="inner-arrow">(602) 519-0450 <span>PHONE</span></div>
                </div>
                <div class="arrow back">
                    <div class="inner-arrow"><a href="mailto:company@example.com">company@example.com</a>
                        <span>EMAIL</span></div>
                </div>
            </div>
        </div>
        <div id="notices">
            <div>NOTICE:</div>
            <div class="notice">A finance charge of 1.5% will be made on unpaid balances after 30 days.</div>
        </div>
    </main>
    <footer>
        Invoice was created on a computer and is valid without the signature and seal.
    </footer>
</body>

</html>",
    "stringMap": {
        "title": "Invoice #100",
        "date": "January 1st, 2024",
        "dueDate": "January 31st, 2024",
        "subtotal": "$5,040",
        "taxTitle": "TAX 15%",
        "taxAmount": "$756",
        "grandTotal": "$5,796"
    },
    "listMap": {
        "serviceList": [
            "Design",
            "Development",
            "SEO"
        ],
        "descriptionList": [
            "Creating a recognizable design solution based on the company's existing visual identity",
            "Developing a Content Management System-based Website",
            "Optimize the site for search engines (SEO)"
        ],
        "unitList": [
            "$40.00",
            "$40.00",
            "$40.00"
        ],
        "quantityList": [
            "26",
            "80",
            "20"
        ],
        "totalAmountList": [
            "$1,040.00",
            "$3,200.00",
            "$800.00"
        ]
    },
    "responseType": "JSON"
}

And the generated PDF is
example-html.pdf

At first, SimplePdfGenAPI prepares the HTML using the Thymeleaf template engine. Then it leverages openhtmltopdf to render PDF from HTML. If you do not want to provide fonts through HTML, add font source URLs in the fileUrlMap. SimplePdfGenAPI will download and add the fonts during PDF rendering.

Postman Documentation URL

https://documenter.getpostman.com/view/4531605/2s9YsNcVGU

Contributing

Please!

Inspiration

About

πŸ“‘ Document Generation as a REST service. It supports PDF Generation from LaTex and HTML templates.

Resources

Stars

Watchers

Forks

Packages

No packages published