JavaClearHttp

JavaClearHttp is yet another HTTP client in Java. Why reinventing the wheel? You may ask. As the name suggests, its purpose is to show the HTTP communication transparently. Clear communication may help you with various tasks such as API investigation or documentation. For example, you may want to write some tutorials on the GitHub API. It would be helpful to document what messages you exactly sent and what replies exactly the server gave you. Sure, you can do it with more powerful HTTP clients such as Apache HttpClient. However, we believe JavaClearHttp provides an easier way to obtain information about HTTP communication.

Usages

This section shows some examples of JavaClearHttp usages.

Send GET request

RecordType record = new Http("https://api.github.com/users/octocat/orgs")
    .get()
    .send();
System.out.println(record);

Output:

URL: https://api.github.com/users/octocat/orgs
Host: api.github.com
Method: GET
Protocol: HTTPS
Port: 443

Messages:
GET /users/octocat/orgs HTTP/1.1
Host: api.github.com
User-Agent: JavaClearHttp
Accept: */*
Connection: close


Replies:
HTTP/1.1 200 OK
Date: Sun, 08 Mar 2020 17:30:12 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 2
Connection: close
Server: GitHub.com
Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1583692212
Cache-Control: public, max-age=60, s-maxage=60
Vary: Accept
ETag: "98f0c1b396a4e5d54f4d5fe561d54b44"
X-GitHub-Media-Type: github.v3; format=json
Access-Control-Expose-Headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset
Access-Control-Allow-Origin: *
Strict-Transport-Security: max-age=31536000; includeSubdomains; preload
X-Frame-Options: deny
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: origin-when-cross-origin, strict-origin-when-cross-origin
Content-Security-Policy: default-src 'none'
Vary: Accept-Encoding, Accept, X-Requested-With
X-GitHub-Request-Id: 0500:0877:80D903:A2C8BB:5E652BA4

[]

Send POST request

final String content = "{\"title\": \"Found a bug\",\"body\": \"I am having a problem with this.\"}";
final RecordType record = new Http("https://api.github.com/repos/levelrin/javaclearhttp/issues")
    .post()
    .header("Authorization", "token access_token")
    .header("Content-Type", "application/json")
    .body(content)
    .send();
System.out.println(record);

Output:

URL: https://api.github.com/repos/levelrin/javaclearhttp/issues
Host: api.github.com
Method: POST
Protocol: HTTPS
Port: 443

Messages:
POST /repos/levelrin/javaclearhttp/issues HTTP/1.1
Authorization: token access_token
Accept: */*
User-Agent: JavaClearHttp
Connection: close
Host: api.github.com
Content-Length: 67
Content-Type: application/json

{"title": "Found a bug","body": "I am having a problem with this."}

Replies:
HTTP/1.1 201 Created
Date: Sun, 08 Mar 2020 18:52:40 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 1746
Connection: close
Server: GitHub.com
Status: 201 Created
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4995
X-RateLimit-Reset: 1583693785
Cache-Control: private, max-age=60, s-maxage=60
Vary: Accept, Authorization, Cookie, X-GitHub-OTP
ETag: "06cf509d046f315929650076f5227a4a"
X-OAuth-Scopes: admin:enterprise, admin:gpg_key, admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete:packages, delete_repo, gist, notifications, read:packages, repo, user, workflow, write:discussion, write:packages
X-Accepted-OAuth-Scopes: 
Location: https://api.github.com/repos/levelrin/JavaClearHttp/issues/8
X-GitHub-Media-Type: github.v3; format=json
Access-Control-Expose-Headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset
Access-Control-Allow-Origin: *
Strict-Transport-Security: max-age=31536000; includeSubdomains; preload
X-Frame-Options: deny
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: origin-when-cross-origin, strict-origin-when-cross-origin
Content-Security-Policy: default-src 'none'
Vary: Accept-Encoding, Accept, X-Requested-With
X-GitHub-Request-Id: 0502:0877:81F2E6:A41FDD:5E653EF8

{"url":"https://api.github.com/repos/levelrin/JavaClearHttp/issues/8","repository_url":"https://api.github.com/repos/levelrin/JavaClearHttp","labels_url":"https://api.github.com/repos/levelrin/JavaClearHttp/issues/8/labels{/name}","comments_url":"https://api.github.com/repos/levelrin/JavaClearHttp/issues/8/comments","events_url":"https://api.github.com/repos/levelrin/JavaClearHttp/issues/8/events","html_url":"https://github.com/levelrin/JavaClearHttp/issues/8","id":577546740,"node_id":"MDU6SXNzdWU1Nzc1NDY3NDA=","number":8,"title":"Found a bug","user":{"login":"levelrin","id":51286045,"node_id":"MDQ6VXNlcjUxMjg2MDQ1","avatar_url":"https://avatars0.githubusercontent.com/u/51286045?v=4","gravatar_id":"","url":"https://api.github.com/users/levelrin","html_url":"https://github.com/levelrin","followers_url":"https://api.github.com/users/levelrin/followers","following_url":"https://api.github.com/users/levelrin/following{/other_user}","gists_url":"https://api.github.com/users/levelrin/gists{/gist_id}","starred_url":"https://api.github.com/users/levelrin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/levelrin/subscriptions","organizations_url":"https://api.github.com/users/levelrin/orgs","repos_url":"https://api.github.com/users/levelrin/repos","events_url":"https://api.github.com/users/levelrin/events{/privacy}","received_events_url":"https://api.github.com/users/levelrin/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2020-03-08T18:52:40Z","updated_at":"2020-03-08T18:52:40Z","closed_at":null,"author_association":"OWNER","body":"I am having a problem with this.","closed_by":null}

How to use?

You just need to add the dependency like so:

Gradle:

dependencies {
    implementation 'com.levelrin:javaclearhttp:0.1.1'
}

Maven:

<dependency>
  <groupId>com.levelrin</groupId>
  <artifactId>javaclearhttp</artifactId>
  <version>0.1.1</version>
</dependency>

Requirements:

1. JDK 1.8+

How to contribute?

1. Create a ticket.
2. Run ./gradlew build and make sure the build is clean.
3. Modify the code.
4. Send a pull request.