Git Product home page Git Product logo

rest-client's Introduction

RestClient

RestClient is Java Command/Handler pattern based REST Client allowing easy Command based REST invocations in any Java App using Spring.

Setup

  • RestClient requires SpringBoot to run.
  • RestClient can be used by applying @EnableRestClient annotation on your project's Configuration bean.
  • Your application.properties should have the following definitions:
rest.client.serverBaseUrl = http://url-to-server:port
rest.client.connectionTimeout = timeout-in-ms
rest.client.readTimeout = timeout-in-ms

RestMethod

All invocations that can be executed with this RestClient are to implement RestMethod<RESULT_TYPE> interface. The RESULT_TYPE maybe either a direct return value DTO type or a Collection<DTO>, for example:

class GetCustomersMethod implements RestMethod<List<Customer>>

or

class GetCustomerMethod implements RestMethod<Customer>

The methods then need to be annotated with RestMethodConfiguration that specifies the serviceUri's relative part as well as which HttpMethod is used (GET, POST...)

Once done the @Autowired RestClient can be used to invoke the methods directly for example.

@Autowired
private RestClient client;

List<Customer> customers = client.invoke(new GetCustomersMethods());
Customer customer = client.invoke(new GetCustomerMethods(123));

The client will automatically take care of all type conversion and return type handling as long as the invoked REST method really returns JSON or XML that can be mapped to expected <RESULT_TYPE>.

rest-client's People

Contributors

peterl1084 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.