Skip to content

mTxServ/hytale-api-sdk-java

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Hytale Official API - JAVA SDK

Hytale Official API - JAVA SDK

Created by mTxServ and Hytale.game. With this SDK, you can consume the official Hytale API in Java.

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>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

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

Getting Started

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

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ArticlesApi;

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

public class ArticlesApiExample {

    public static void main(String[] args) {
        
        ArticlesApi apiInstance = new ArticlesApi();
        String slug = "slug_example"; // String | Slug of article
        try {
            Article result = apiInstance.getArticleBySlug(slug);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#getArticleBySlug");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://www.hytale.com/api

Class Method HTTP request Description
ArticlesApi getArticleBySlug GET /blog/post/slug/{slug}
ArticlesApi getArticles GET /blog/post/published
ArticlesApi getArticlesOfMonthAndYear GET /blog/post/archive/{year}/{month}/
JobsApi getJobs GET /job/listing

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

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