Worcade API client

A library for interacting with the Worcade API

License

License

Categories

Categories

Net CLI User Interface
GroupId

GroupId

net.worcade
ArtifactId

ArtifactId

api-client
Last Version

Last Version

1.1.2
Release Date

Release Date

Type

Type

jar
Description

Description

Worcade API client
A library for interacting with the Worcade API
Source Code Management

Source Code Management

https://github.com/Worcade/api-client-java

Download api-client

How to add to project

<!-- https://jarcasting.com/artifacts/net.worcade/api-client/ -->
<dependency>
    <groupId>net.worcade</groupId>
    <artifactId>api-client</artifactId>
    <version>1.1.2</version>
</dependency>
// https://jarcasting.com/artifacts/net.worcade/api-client/
implementation 'net.worcade:api-client:1.1.2'
// https://jarcasting.com/artifacts/net.worcade/api-client/
implementation ("net.worcade:api-client:1.1.2")
'net.worcade:api-client:jar:1.1.2'
<dependency org="net.worcade" name="api-client" rev="1.1.2">
  <artifact name="api-client" type="jar" />
</dependency>
@Grapes(
@Grab(group='net.worcade', module='api-client', version='1.1.2')
)
libraryDependencies += "net.worcade" % "api-client" % "1.1.2"
[net.worcade/api-client "1.1.2"]

Dependencies

compile (1)

Group / Artifact Type Version
org.slf4j : slf4j-api jar 1.7.25

runtime (1)

Group / Artifact Type Version
com.google.guava : guava jar 27.0-jre

Project Modules

There are no modules declared in this project.

api-client-java

Client library for the Worcade public API, in Java

Basic usage

Obtain a Worcade instance using the builder method. Log in using the loginUserByEmail endpoint and your existing Worcade account. Then use the various getApi methods to make requests.

For code examples, see the examples package

Runtime requirements

To use this library, a HTTP client and a JSON provider must be available at runtime. An implementation using Jersey Client and Jackson is available in the jersey-client module, but it should be possible to substitute other implementations. To do so, implement the WorcadeClientBuilder interface and return a subclass of WorcadeClient.

To run with the Jersey client, use these dependencies:

compile 'net.worcade:api-client:1.0.0'
runtime 'net.worcade:api-client-jersey:1.0.0'

License and contributors

Versions

Version
1.1.2
1.1.1
1.1.0
1.0.1
1.0.0