Skip to content

Update README.md #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JuliaDanilyuk wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fedc2dd
Update README.md
JuliaDanilyuk Feb 7, 2018
682dc07
Update README.md
JuliaDanilyuk Feb 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## Http ActionService
REST service for [Janet](https://github.com/techery/janet). Supports fully customizable requests, http-clients and converters.
## HTTP ActionService
The REST service for [Janet](https://github.com/techery/janet) supports fully customizable requests, HTTP clients and converters.

### Getting Started
##### 1. Define service and add it to `Janet`
##### 1. Define a service and add it to `Janet`
```java
ActionService httpService = new HttpActionService(API_URL, new OkClient(), new GsonConverter(new Gson()))
Janet janet = new Janet.Builder().addService(httpService).build();
```

Service requires: End-point url, [HttpClient](clients) and [Converter](https://github.com/techery/janet-converters).
The service requires: endpoint URL, [HttpClient](clients) and [Converter](https://github.com/techery/janet-converters).

##### 2. Define Request-Response action class
##### 2. Define a request/response action class
```java
@HttpAction(value = "/demo", method = HttpAction.Method.GET)
public class ExampleAction {
Expand All @@ -20,7 +20,7 @@ public class ExampleAction {
Each action is an individual class that contains all information about the request and response.
It must be annotated with `@HttpAction`

##### 3. Use `ActionPipe` to send/observe action
##### 3. Use `ActionPipe` to send/observe an action
```java
ActionPipe<ExampleAction> actionPipe = janet.createPipe(ExampleAction.class);
actionPipe
Expand All @@ -33,26 +33,26 @@ actionPipe
);
```

### Http Action Configuration
### HTTP Action Configuration

Request path, method and type are defined by `@HttpAction` annotation:
The request path, method and type are defined by the `@HttpAction` annotation:
* `value` – url path
* `method` – get/post/put/delete/head/patch
* `type` –  simple/multipart/form_url_encoded

To configure request, Action fields can be annotated with:
* `@Path` for path value
* `@Url` rewrites full url or suffixes
* `@Query` for request URL parameters
* `@Body` for POST request body
* `@Field` for request fields if request type is `HttpAction.Type.FORM_URL_ENCODED`
To configure requests, action fields can be annotated with:
* `@Path` for a path value
* `@Url` to rewrite full URLs or only URL suffixes
* `@Query` to request URL parameters
* `@Body` for the POST request body
* `@Field` for request fields if a request type is `HttpAction.Type.FORM_URL_ENCODED`
* `@Part` for multipart request parts
* `@RequestHeader` for request headers

To process response, special annotations can be used:
* `@Response` for getting response body.
* `@Status` for getting response status. Field types `Integer`, `Long`, `int` or `long` can be used to get status code or use `boolean` to know that request was sent successfully
* `@ResponseHeader` for getting response headers
To process responses, special annotations can be used:
* `@Response` to get the response body
* `@Status` to get the response status. The field types `Integer`, `Long`, `int` or `long` can be used to get the status code. Alternatively, you can use `boolean` to learn if a request was sent successfully
* `@ResponseHeader` to get response headers

Example:
```java
Expand All @@ -73,13 +73,13 @@ public class ExampleAction {
}
```

### Advanced bits
* supports request progress;
* supports request cancelation;
* provides useful `HttpException` for failed requests;
### Advanced Bits
* supports request progress
* supports request cancelation
* provides useful `HttpException` for failed requests
* supports action inheritance
* based on annotation processing
* consider using javac option `'-Ajanet.http.factory.class.suffix=MyLib'` for api libraries
* consider using the javac option `'-Ajanet.http.factory.class.suffix=MyLib'` for API libraries

### Download
```groovy
Expand Down Expand Up @@ -116,7 +116,7 @@ dependencies {

### Notes
`HttpActionService` is highly inspired by `Retrofit2` – thanks guys, it's awesome!
We put our effort to make it even more flexible and reusable, so everyone who loves `Retrofit` and reactive approach should give it a try.
We put our effort to make it even more flexible and reusable, so everyone who loves `Retrofit` and a reactive approach should give it a try.

## License

Expand Down