springboot-itext5-velocity-example

A Demo project for generating PDF reports in Spring Boot using IText 5 & Apache Velocity.

Steps to deploy

• Just load this project on your preferred IDE e.g. Intellij or Netbeans ...etc and Maven will load all dependencies and configure directories.
• This project uses an embedded "h2 database" so there's no need for a dbms e.g. MySQL or Postgres ...etc

Testing

• Provided with two testing templates, You can use Postman or something similar to test functionalities.
• Use the following POST request url.

http://localhost:8080/report/pdf

• Note: Supported responses are [application/pdf, text/plain]. The second option is useful in cases when you need to return just a path for the generated pdf file {a performance-wise choice -> helps in some cases} so, you need to specify the returned response using the [Accept] HTTP header.

Example (1) Pets Report :

{
    "reportName": "Pets Report",
    "data": {
        "petList": [
            {
                "price": 800,
                "name": "Bold Eagle"
            },
            {
                "price": 0,
                "name": "My EX"
            }
        ]
    }
}

Example (2) Employees Report :

{
    "reportName": "Employees Report",
    "data": {
        "employeesList": [
            {
                "salary": 10000,
                "name": "John Doe",
                "joining_date": 1633694734587
            },
            {
                "salary": 15000,
                "name": "Muhammad Ali",
                "joining_date": 1633694734587
            },
            {
                "salary": 800,
                "name": "Bill Gates",
                "joining_date": 1633694734587
            },
            {
                "salary": 0,
                "name": "Michael Truman",
                "joining_date": 1633694734587
            },
            {
                "salary": 800,
                "name": "Sara Whatever",
                "joining_date": 1633694734587
            },
            {
                "salary": 1200,
                "name": "Steve Jobs",
                "joining_date": 1633694734587
            }
        ],
        "reason": "Requested by the CEO.",
        "note": "From the fall of 2020.",
        "issued_by": "Mr. Nicola Tesla.",
        "descriptionList": [
            {
                "description": "This data is discloused and not eligable to be shared outside of the organization."
            },
            {
                "description": "Refer to your manager if you find data outdated or somehow incorrect."
            },
            {
                "description": "Contact Dev Team (+201114388288) for any report UI issues."
            }
        ]
    }
}

Example (3) Banking Invoice Report :

{
    "reportName": "Auto Debit Recharge Information",
    "data": {
        "invoice_data":"Accounting & Billing",
        "customer_name":"John Doe",
        "invoice_number":83,
        "address":"24 Mohammed Mazhar, Zamalek, Giza Governorate",
        "amount":5000,
        "mobile_number":"+201114566266",
        "dataList": [
            {
                "month": "September 2021",
                "invoice_date": "2021-09-22 02:2:34",
                "invoice_number":80 ,
                "amount": 2500,
                "num_category": 4,
                "call_plan": "2021-09-18 14:5:34",
                "payment_date":"2021-09-10 08:5:34",
                "upload_date": "2021-09-22 02:2:34",
                "status": "Accepted"
            },
            {
            "month": "October 2021",
                "invoice_date": "2021-10-02 02:2:34",
                "invoice_number":81 ,
                "amount": 8700,
                "num_category": 4,
                "call_plan": "2021-10-01 01:6:02",
                "payment_date":"2021-10-03 12:6:04",
                "upload_date": "2021-10-07 02:2:50",
                "status": "Declined"
            }
        ]
    }
}

Authors