https://github.com/antechrestos/rest-client-test

https://github.com/antechrestos/rest-client-test

rest spring unit-testing

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/antechrestos/rest-client-test
• Owner: antechrestos
• License: apache-2.0
• Archived: true
• Created: 2016-06-20T07:54:32.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-06-25T15:57:18.000Z (about 8 years ago)
• Last Synced: 2025-11-27T15:32:04.581Z (7 months ago)
• Topics: rest, spring, unit-testing
• Language: Java
• Size: 33.2 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Rest Client Test  [![maven](http://img.shields.io/maven-central/v/com.github.antechrestos/restclienttest.svg)](https://oss.sonatype.org/#nexus-search;quick~restclienttest) [![license](https://img.shields.io/github/license/antechrestos/rest-client-test.svg)](https://raw.githubusercontent.com/antechrestos/rest-client-test/master/LICENSE)

## Description

This project brings you a simple library to mock spring rest template in order to test your client.

Example: The following example registers a `POST` made on `http://somewhere.org`, with the request body `"some body"`. This call will return a `OK` status code with the content of the file found in classpath `fixtures/POST.json`.

The call to `restTemplate` must be a `POST` on the matching `url`. The call will check that the body submitted matched the one given at context registration.

```java

restTemplate.setRequestFactory(clientHttpRequestFactory);

clientHttpRequestFactory.register(

		Context.builder()

				.url("http://somewhere.org")

				.queryParameter("some_parameter", Collections.singletonList("some_value"))

				.statusCode(HttpStatus.OK)

				.method(HttpMethod.POST)

				.requestPayload(Payload.builder()

						.type(Payload.Type.RAW_STRING)

						.value("some body")

						.build())

     				.responsePayload(Payload.builder()

      						.type(Payload.Type.CLASSPATH_RESOURCE)

						.value("fixtures/POST.json")

						.build())

				.build()

);

// use restTemplate

```

### Query parameters

Query parameters may either be specified in the `url`creation paramers, or by using the `builder` method `queryParameter`. If both way are used, the checked query parameters will be a merge of the two methods.

They are checked when the call is made.

### Request headers

Headers specified by the `builder` method `header` are checked when the call is made.

### Request payload

A check on the body that is sent can be made. You may either specify a `Payload.Type.RAW_STRING` or a `Payload.Type.CLASSPATH_RESOURCE`where the content will be loaded and compared to the sent body.

### Status code

The status code that will be returned

### Response headers

The headers that will be sent by the call.

### Response payload

The response body returned. You may either specify a `Payload.Type.RAW_STRING` or a `Payload.Type.CLASSPATH_RESOURCE` where the content will be loaded and sent as a body.

## Add to your project

Add the dependency to your project by using maven:

```xml

    com.github.antechrestos

    restclienttest

    1.1.0

```