Skip to content

Endpoint

module Azu::Endpoint(Request, Response)

Defines a Azu endpoint. The endpoint is the final stage of the request process Each endpoint is the location from which APIs can access the resources of your application to carry out their function.

Azu endpoints is a simple module that defines the request and response object to execute your application business domain logic. Endpoints specify where resources can be accessed by APIs and the key role is to guarantee the correct functioning of the calls.

Correctness

To ensure correctness Azu Endpoints are design with the Request and Response pattern in mind you can think of it as input and output to a function, where the request is the input and the response is the output.

Request and Response objects are type safe objects that can be designed by contract. Read more about Azu::Contract

module ExampleApp
  class UserEndpoint
    include Azu::Endpoint(UserRequest, UserResponse)
  end
end

Included modules

HTTP::Handler

Methods

abstract #call : Response

View source