openapi-android-client

Requirements

Building the API client library requires Maven to be installed.

Installation

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

mvn install

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

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-android-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.openapitools:openapi-android-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/openapi-android-client-1.0.0.jar
• target/lib/*.jar

Getting Started

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

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {

    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        UUID uuid = null; // UUID | 
        UUID authUser = null; // UUID | 
        String authorization = null; // String | 
        String xRealIp = null; // String | 
        Boolean textonly = false; // Boolean | 
        try {
            Article result = apiInstance.articleUuidGet(uuid, authUser, authorization, xRealIp, textonly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleUuidGet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://http:/v3

Class	Method	HTTP request	Description
ArticlesApi	articleUuidGet	GET /article/{uuid}
ArticlesApi	articleUuidStubGet	GET /article/{uuid}/stub
CategoriesApi	categoriesGet	GET /categories	Read categories
ListsApi	frontpageGet	GET /frontpage	Returns a list for a front page
ListsApi	latestGet	GET /latest	Returns a list of latest articles
ListsApi	mostreadGet	GET /mostread	Returns a list of most read articles
ListsApi	presetPresetCategoryGet	GET /preset/{preset}/{category}	Load a preset model
ListsApi	presetPresetCategoryPost	POST /preset/{preset}/{category}	Update a preset model
ListsApi	searchGet	GET /search	Returns a list of search results
ListsApi	tagTagGet	GET /tag/{tag}	Returns a list of latest articles by tag

Documentation for Models

• Alignment
• Article
• ArticleStub
• ArticleType
• ArticleTypeDetails
• Author
• Block
• BoxInfo
• BoxType
• Category
• Cutoff
• ImageInfo
• Paper
• Scoring

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.

Author