SAService Architect Back to designer
SAService ArchitectDocumentation
Data connectorsHTTP
Endpoint type HTTP / endpoint

HTTP endpoint

A concrete HTTP route used as a source or sink.

When to use

Create this endpoint inside a HTTP connector, then select it from an Input or Sink stream.

Behavior

  • Defines one concrete entry or exit point.
  • Its owning connector supplies the transport.

General properties

Endpoint identity

PropertyTypeDescription
namestring

Endpoint name unique in the topology.

Required

HTTP properties

HTTP endpoint contract

PropertyTypeDescription
httpMethodTypeGET | POST

HTTP verb.

Default: POSTAllowed: GET, POST
pathstring

Unique route path.

Required

Function properties

Generated transport handler and code placement

PropertyTypeDescription
functionNamesymbol

Generated endpoint handler name.

functionPackagerelative path

Optional placement below the target-language functions root. Empty uses the root directly; folder/sub-folder is resolved relative to the root selected by publicFunction and functionModule. See Code Generation / Packages and Modules for the language matrix.

Default: empty (functions root)
publicFunctionboolean

Places the handler in shared code.

Default: false
functionDescriptiontext

Generated documentation comment.

functionInitializerGroupstring

Dependency-injection initialization group.

functionModuleModule

Shared module for the handler.

Visible when publicFunction is true.

Configuration example

name: Create order
httpMethodType: POST
path: /v1/orders