Quickly and easily access any RESTful or RESTful-like API.

If you are looking for the SendGrid API client library, please see this repo.

Table of Contents

• Announcements
• Installation
• Quick Start
• Usage
• How to Contribute
• About
• Support
• License

Announcements

All updates to this project are documented in our CHANGELOG.

Installation

Prerequisites

• Java 8, 11, or 17

Install via Maven w/ Gradle

...
dependencies {
...
compile 'com.sendgrid:java-http-client:4.5.1'
}
repositories {
mavenCentral()
}
...

Maven

<dependency>
<groupId>com.sendgrid</groupId>
<artifactId>java-http-client</artifactId>
<version>4.5.1</version>
</dependency>

mvn install

Dependencies

• Please see the pom.xml file

Quick Start

Here is a quick example:

GET /your/api/{param}/call

Clientclient = newClient();
Requestrequest = newRequest();
request.setBaseUri("api.test.com");
request.setMethod(Method.GET);
Stringparam = "param";
request.setEndpoint("/your/api/" + param + "/call");
try {
Responseresponse = client.api(request);
System.out.println(response.getStatusCode());
System.out.println(response.getBody());
System.out.println(response.getHeaders());
} catch (IOExceptionex) {
throwex;
}

POST /your/api/{param}/call with headers, query parameters and a request body.

request.addHeader("Authorization", "Bearer YOUR_API_KEY");
request.addQueryParam("limit", "100");
request.addQueryParam("offset", "0");
// Will be parsed to categories=cake&categories=pie&categories=bakingrequest.addQueryParam("categories", "cake&pie&baking");
request.setBody("{\"name\": \"My Request Body\"}");
request.setMethod(Method.POST);
Stringparam = "param";
request.setEndpoint("/your/api/" + param + "/call");
try {
Responseresponse = client.api(request);
System.out.println(response.getStatusCode());
System.out.println(response.getBody());
System.out.println(response.getHeaders());
} catch (IOExceptionex) {
throwex;
}

How to Contribute

We encourage contribution to our projects please see our CONTRIBUTING guide for details.

Quick links:

• Feature Request
• Bug Reports
• Improvements to the Codebase
• Review Pull Requests

About

java-http-client is maintained and funded by Twilio SendGrid, Inc. The names and logos for java-http-client are trademarks of Twilio SendGrid, Inc.

Support

If you need help using SendGrid, please check the Twilio SendGrid Support Help Center.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

License

The MIT License (MIT)