Packet Java API client
Switch branches/tags
Nothing to show
Clone or download
Aaron Welch
Aaron Welch add javadoc link
Latest commit a6d9536 Sep 16, 2016

README.md

Packet API Java Client

License

Lightweight Java client library for accessing Packet REST APIs with project based (JVM hosted languages) on Java, Groovy, Scala, Clojure, etc.

Getting Started

Packet API Java Client is available in Maven Central Repo.

Maven dependency

<dependency>
    <groupId>net.packet</groupId>
    <artifactId>java-client</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle/Grails dependency

compile 'net.packet:java-client:1.0.0'

Groovy Grape

@Grapes(
@Grab(group='net.packet', module='java-client', version='1.0.0')
)

Scala SBT

libraryDependencies += "net.packet" % "java-client" % "1.0.0"

Note: For Android projects, kindly include the httpclient-android library explicitly in your project dependencies.

Getting Help

How to create Packet API Java Client?

Simply you will have to call constructors!

// Passing authToken and version
Packet apiClient = new PacketClient("authToken", "1");

// Passing authToken, version and HTTP Client. Create a http client with custom settings
CloseableHttpClient httpClient = HttpClients.createDefault();
Packet apiClient = new PacketClient("authToken", "1", httpClient);

Then, call appropriate methods as per your need!

Reporting Issues

Packet API Java Client uses GitHub’s integrated issue tracking system to record bugs and feature requests. If you need to paste code, or include a stack trace use Markdown ``` escapes before and after your text.

Client Library Changelog

Refer CHANGELOG.md

Contributing

  1. Fork it
  2. Create your feature branch - git checkout -b my-new-feature
  3. Implement your changes and apply Google Java Code Formatter
  4. Add integration test cases for your implementation
  5. Commit your changes - git commit -am 'Added feature'
  6. Push to the branch - git push origin my-new-feature
  7. Create new Pull Request