JsonApiClient v3.0.4 JsonApiClient.Middleware behaviour View Source

The HTTP client middleware behaviour for the library.

Link to this section Summary

Callbacks

Manipulates a Request and Response objects. If the Request should be processed by the next middleware then next.(request) has to be called

Link to this section Types

Link to this section Callbacks

Link to this callback call(request, function, options) View Source

Manipulates a Request and Response objects. If the Request should be processed by the next middleware then next.(request) has to be called.

Args:

  • request - JsonApiClient.Request that holds http request properties.

This function returns {:ok, response} if the request is successful, {:error, reason} otherwise. response - HTTP response with the following properties:

  • body - body as JSON string.
  • status_code- HTTP Status code
  • headers- HTTP headers (e.g., [{"Accept", "application/json"}])