Services

This package contains a set of interfaces and classes used to create services and handle their operations.

Interfaces

IRegisterable

Interface to perform on-demand registrations.

ISwaggerService

Interface to perform Swagger registrations.

Classes

AboutOperations

Obtains information about running services

CommandableHttpService

Abstract service that receives remote calls via HTTP protocol to operations automatically generated for commands defined in ICommandable. Each command is exposed as a POST operation that receives all parameters in body object.

Commandable services require only three lines of code to implement a robust external HTTP-based remote interface.

CommandableSwaggerDocument

Generates Swagger code that describes created REST API methods and their parameters.

HeartbeatOperations

Handles the operations of a heartbeat service.

HeartbeatRestService

Service returns heartbeat via HTTP/REST protocol.

The service responds on /heartbeat route (can be changed) with a string with the current time in UTC.

This service route can be used to perform health checks by loadbalancers and container orchestrators.

HttpEndpoint

Used for creating HTTP endpoints. An endpoint is a URL, at which a given service can be accessed by a client.

HttpRequestDetector

Helper class that retrieves parameters from HTTP requests.

HttpResponseSender

Helper class that handles HTTP-based responses.

InstrumentTiming

Creates logs, counters and timings for methods that call _instrument.

RestOperations

Handles REST services operations.

RestService

Abstract service that receives remove calls via HTTP/REST protocol.

StatusOperations

Handles status requests for REST operations.

StatusRestService

Service that returns microservice status information via HTTP/REST protocol.