Documentation

Overview

Package starter provides quick starters for hiboot cli/web application.

Auto-configured Starter

Hiboot auto-configuration attempts to automatically configure your Hiboot application based on the pkg dependencies that you have added. For example, if bolt is imported in you main.go, and you have not manually configured any database connection, then Hiboot auto-configures an database bolt for any service to inject.

You need to opt-in to auto-configuration by embedding app.Configuration in your configuration and calling the app.Register() function inside the init() function of your configuration pkg.

For more details, see https://godoc.org/hidevops.io/hiboot/pkg/starter

Creating Your Own Starter

A full Hiboot starter for a library may contain the following structs:

autoconfigure - object that handle the auto-configuration code.
properties - object that contains properties which will be injected configurable default values or user specified values

If you work in a company that develops shared go packages, or if you work on an open-source or commercial project, you might want to develop your own auto-configured starter. starter can be implemented in external packages and can be imported by any go applications.

Understanding Auto-configured Starter

Under the hood, auto-configuration is implemented with standard struct. Additional embedded field app.Configuration. AutoConfiguration used to constrain when the auto-configuration should apply. Usually, auto-configuration struct use `after:"fooConfiguration"` or `missing:"fooConfiguration"` tags. This ensures that auto-configuration applies only when relevant configuration are found and when you have not declared your own configuration.

Example

    This example shows the guide to make customized auto configuration for more details, see https://hidevops.io/hiboot-data/blob/master/starter/bolt/autoconfigure.go

    Output:
    
    

    Source Files

    Directories

    Path Synopsis
    Package actuator provide the health check endpoint for web application Package controller provide the controller for health check
    Package actuator provide the health check endpoint for web application Package controller provide the controller for health check
    Package grpc provides the hiboot starter for injectable grpc client and server dependency
    Package grpc provides the hiboot starter for injectable grpc client and server dependency
    mockgrpc
    Package mockgrpc is a generated GoMock package.
    Package mockgrpc is a generated GoMock package.
    Package jaeger provides the hiboot starter for injectable jaeger dependency
    Package jaeger provides the hiboot starter for injectable jaeger dependency
    Package jwt provides the hiboot starter for injectable jwt dependency
    Package jwt provides the hiboot starter for injectable jwt dependency
    Package locale provides the hiboot starter for injectable locale (i18n) dependency
    Package locale provides the hiboot starter for injectable locale (i18n) dependency
    Package logging provides the hiboot starter for injectable logging dependency
    Package logging provides the hiboot starter for injectable logging dependency
    package swagger auto serve open api doc with swagger 2.0 annotations
    package swagger auto serve open api doc with swagger 2.0 annotations
    Package websocket provides web socket auto configuration for web/cli application
    Package websocket provides web socket auto configuration for web/cli application
    ws
    Package websocket provides rich websocket support for the iris web framework.
    Package websocket provides rich websocket support for the iris web framework.