Skip to main content

Expose

@klotho::expose

The expose capability provides the ability to make your application accessible through an API endpoint.

Exposed objects will be mapped through routes to execution units, to make your executable code be able to receive requests and send responses to the end user. The mapped routes depend upon the implementation within the application's source code. Klotho will analyze your code to identify the routes you've defined in whichever supported framework you use

DirectiveTypeDescription
idstring(Required) The exposed endpoint's id. Changing this results in a new endpoint (URL).
targetstring(Required) Must be set and the only allowed value is "public"

Configuration

Expose resources can be further configured within the Klotho configuration.

The configuration depends upon the provider which is specified in your klotho compilation. Example type configurations

Providers

Creates an API Gateway.