Abstract service that receives remote calls via HTTP/REST protocol to operations automatically generated for commands defined in ICommandable components.

Extends: RestService

See also RestService, CommandableHttpClient


The CommandableHttpService class allows you to create services that receive remote calls via the HTTP/REST protocol to operations automatically generated for commands defined in ICommandable components.

Important points

  • Each command is exposed as POST operation that receives all parameters in the body object.
  • Commandable services require only three lines of code to implement a robust external HTTP-based remote interface.

Configuration parameters

  • base_route: base route for remote URI
  • dependencies:
    • endpoint: override for HTTP Endpoint dependency
    • controller: override for Controller dependency
  • connection(s):
    • discovery_key: (optional) a key to retrieve the connection from IDiscovery
    • protocol: connection protocol: http or https
    • host: host name or IP address
    • port: port number
    • uri: resource URI or connection string with all parameters in it


  • *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
  • *:counters:*:*:1.0 - (optional) ICounters components to pass collected measurements
  • *:traces:*:*:1.0 - (optional) ITracer components to record traces
  • *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connection


Creates a new instance of the service.

public constructor(baseRoute: string)

  • baseRoute: string - a service base route.



Set of commands.

protected _commandSet: CommandSet


Boolean variable that defines whether the configuration of Swagger is autogenerated or not.

protected _swaggerAuto: boolean = True

Instance methods


Configures a component by passing configuration parameters.

public configure(config: ConfigParams): void

  • config: ConfigParams - configuration parameters to be set.


Registers all service routes in the HTTP endpoint.

public register(): void


class MyCommandableHttpService extends CommandableHttpService {
   public constructor() {
          new Descriptor("mygroup","controller","*","*","1.0")

let service = new MyCommandableHttpService();
    "connection.protocol", "http",
    "", "localhost",
    "connection.port", 8080

   new Descriptor("mygroup","controller","default","default","1.0"), controller

console.log("The REST service is running on port 8080");

See also