CommandableHttpService

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

Implements: RestService

Description

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

References

  • *: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

Constructors

InheritCommandableHttpService

Creates a new instance of the service.

InheritCommandableHttpService(overrides IRegisterable, baseRoute string) *CommandableHttpService

  • overrides: IRegisterable - references to child class that overrides virtual methods.
  • baseRoute: string - a service base route.

Fields

commandSet

Set of commands.

commandSet: CommandSet

SwaggerAuto

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

SwaggerAuto: bool = True

Methods

Configure

Configures a component by passing configuration parameters.

(c *CommandableHttpService) Configure(ctx context.Context, config *cconf.ConfigParams)

  • ctx: context.Context - operation context.
  • config: *cconf.ConfigParams - configuration parameters to be set.

Register

Registers all service routes in the HTTP endpoint.

(c *CommandableHttpService) Register()

Examples

type MyCommandableHttpService struct {
	*CommandableHttpService
}

func NewMyCommandableHttpService() *MyCommandableHttpService {
	c := MyCommandableHttpService{
		CommandableHttpService: services.NewCommandableHttpService("dummies"),
	}
	c.DependencyResolver.Put(context.Background(), "controller", cref.NewDescriptor("pip-services-dummies", "controller", "default", "*", "*"))
	return &c
}

service := NewMyCommandableHttpService();
service.Configure(context.Background(), cconf.NewConfigParamsFromTuples(
	"connection.protocol", "http",
	"connection.host", "localhost",
	"connection.port", 8080,
));
service.SetReferences(context.Background(), cref.NewReferencesFromTuples(
	cref.NewDescriptor("mygroup","controller","default","default","1.0"), controller
));

opnErr := service.Open(context.Background(), "123")
if opnErr == nil {
	fmt.Println("The REST service is running on port 8080");
}

See also