Skip to content

README.md

Latest commit

 

History

History
97 lines (68 loc) · 2.4 KB

README.md

File metadata and controls

97 lines (68 loc) · 2.4 KB

pdfapi.io SDK for Java

Installation

pdfapi.io Java SDK can be installed with Gradle or Maven. Add dependency for Gradle project:

# Add Bitweb's public Maven repository
maven {
    url "https://nexus.bitweb.ee/repository/maven-public/"
}

implementation group: 'io.pdfapi', name: 'sdk', version: '3.1.0'

Usage

Usage of pdfapi PHP SDK is very simple. The easiest way to get started is:

import io.pdfapi.sdk.PdfApi;

import java.io.*;

String template = "<html>\n" +
        "    <body>\n" +
        "        <h1>pdfapi.io makes PDF generation so easy.</h1>\n" +
        "        <p>And it can do complicated stuff.</p>\n" +
        "    </body>\n" +
        "</html>";

PdfApi pdf = PdfApi.withBaseUrl("http://pdfapi:400/api");
pdf.setHtml(template);

InputStream rawPdf = pdf.generate();

Full example of the usage: Note: Be aware that header and footer are separate HTML documents (with styles and everything) that are copied to each page.

import io.pdfapi.sdk.PdfApi;
import io.pdfapi.sdk.parameter.Margin;
import io.pdfapi.sdk.parameter.Orientation;
import io.pdfapi.sdk.parameter.Size;

import java.io.*;

String template = "<html>\n" +
        "    <body>\n" +
        "        <h1>pdfapi.io makes PDF generation so easy.</h1>\n" +
        "        <p>And it can do complicated stuff.</p>\n" +
        "    </body>\n" +
        "</html>";

String header = "<html>\n" +
        "  <body>\n" +
        "      <p>pdfapi.io</p>\n" +
        "  </body>\n" +
        "</html>";

String footer = "<html>\n" +
        "  <body>\n" +
        "      <p>pdfapi.io</p>\n" +
        "  </body>\n" +
        "</html>";

PdfApi pdf = PdfApi.withBaseUrl("http://pdfapi:400/api");
pdf.setHtml(template);
pdf.setHeader(header);
pdf.setFooter(footer);
pdf.setSize(Size.A4);
pdf.setOrientation(Orientation.Landscape);
pdf.setMargins(new Margin(60, 60, 60, 60));

InputStream rawPdf = pdf.generate();

//or optionally you can save PDF directly to file
pdf.save("/path/to/file.pdf");

Release notes

3.1.0

  • Restore Java 8 compatibility

3.0.0

This release requires version 29 or later of pdf-api Docker container!

  • Added option to disable smart shrink (enabled by default to be backwards compatible)
  • BREAKING: Removed anything related to api keys and quotas
  • BREAKING: Removed public PdfApi constructors, use PdfApi.withBaseUrl(String baseUrl) instead