api

package

v1.23.8 Latest Latest Go to latest Published: Aug 16, 2026 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/lishimeng/app-starter

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DefaultLiveness() int
func DefaultReadiness() int
func EnableComponents(srv *server.Server, components ...server.Component) (err error)
func EnableStatic(srv *server.Server, assetFile func() http.FileSystem) (err error)
func Healthy(ctx server.Context)
func JwtTokenVerify(ctx server.Context)
func Ready(ctx server.Context)
func Router(app server.Router)
func Server(conf server.Config) (srv *server.Server, err error)
func Start(ctx context.Context, srv *server.Server) (err error)
func StartAdmin(ctx context.Context, cfg server.AdminConfig) (err error)
type LogLevelReq
type Resp

Constants ¶

This section is empty.

Variables ¶

View Source

var LivenessHandler func() int

View Source

var MonitorPrefix = "/m"

View Source

var ReadinessHandler func() int

Functions ¶

func DefaultLiveness ¶ added in v1.23.2

func DefaultLiveness() int

DefaultLiveness answers whether the process is alive (no dependency checks).

func DefaultReadiness ¶ added in v1.23.2

func DefaultReadiness() int

DefaultReadiness checks optional enabled dependencies: DB, Redis, MQTT. Unconfigured components are skipped; any configured but unreachable dependency returns 503.

func EnableComponents ¶ added in v1.0.2

func EnableComponents(srv *server.Server, components ...server.Component) (err error)

func EnableStatic ¶ added in v1.0.2

func EnableStatic(srv *server.Server, assetFile func() http.FileSystem) (err error)

func Healthy ¶ added in v1.5.0

func Healthy(ctx server.Context)

func JwtTokenVerify ¶ added in v1.9.3

func JwtTokenVerify(ctx server.Context)

func Ready ¶ added in v1.5.0

func Ready(ctx server.Context)

func Router ¶ added in v1.5.0

func Router(app server.Router)

func Server ¶

func Server(conf server.Config) (srv *server.Server, err error)

func Start ¶ added in v1.0.2

func Start(ctx context.Context, srv *server.Server) (err error)

func StartAdmin ¶ added in v1.23.7

func StartAdmin(ctx context.Context, cfg server.AdminConfig) (err error)

Types ¶

type LogLevelReq ¶ added in v1.8.8

type LogLevelReq struct {
	Level string `json:"level,omitempty"`
}

type Resp ¶ added in v1.8.10

type Resp struct {
	Code    int    `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL