doxey-client-java

Doxey API

• API version: 1.0.0
  • Build date: 2019-12-31T12:13:16.559Z

Generate personalized documents using doxey template language

For more information, please visit https://doxey.io

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.floreysoft</groupId>
  <artifactId>doxey-client-java</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.floreysoft:doxey-client-java:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/doxey-client-java-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.floreysoft.doxey.invoke.*;
import com.floreysoft.doxey.invoke.auth.*;
import com.floreysoft.doxey.model.*;
import com.floreysoft.doxey.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String apiKey = "apiKey_example"; // String | API key
        String template = "template_example"; // String | URL (http or data) of the source file
        String locale = "locale_example"; // String | The locale ('de', 'en' ...)
        String currency = "currency_example"; // String | The currency ('USD', 'EUR' ...)
        String timezone = "timezone_example"; // String | The timezone ('Europe/Berlin', 'GMT+06:00' ...)
        String format = "format_example"; // String | Target format
        Object model = null; // Object | Variable model
        try {
            File result = apiInstance.mergeGet(apiKey, template, locale, currency, timezone, format, model);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#mergeGet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.doxey.io

Class	Method	HTTP request	Description
DefaultApi	mergeGet	GET /v1/merge
DefaultApi	mergePost	POST /v1/merge

Documentation for Models

• Model
• Params

Documentation for Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: key
• Location: URL query string

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]