outputs

Documentation

Index

• Constants
• func WithAzureFunctionsOutput(directoryPath string) astra.Option
• func WithJSONOutput(filePath string) astra.Option
• func WithOpenAPIOutput(filePath string) astra.Option

Constants

const (
	OutputModeAzureFunctions astra.OutputMode = "azureFunctions" // Azure Functions HTTP Trigger Bindings.
	OutputModeJSON           astra.OutputMode = "json"           // JSON file - primarily used for debugging.
	OutputModeOpenAPI        astra.OutputMode = "openapi"        // OpenAPI 3.0 file.
)

Functions

func WithAzureFunctionsOutput

func WithAzureFunctionsOutput(directoryPath string) astra.Option

WithAzureFunctionsOutput adds Azure Functions HTTP Trigger Bindings as an output to the service.

func WithJSONOutput

func WithJSONOutput(filePath string) astra.Option

WithJSONOutput adds JSON as an output to the service. It will generate a JSON file with the routes and components. It should also contain the configuration for the file path to store in the cache for CLI usage.

func WithOpenAPIOutput

func WithOpenAPIOutput(filePath string) astra.Option

WithOpenAPIOutput adds an OpenAPI specification as an output to the service. It will generate a JSON/YAML file (based on file path [default JSON]) with the routes and components. It should also contain the configuration for the file path to store in the cache for CLI usage.