status

package

v1.3.0 Latest Latest Go to latest Published: Oct 23, 2023 License: AGPL-3.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

codeberg.org/genofire/golang-lib

Links

Open Source Insights

Documentation ¶

Overview ¶

Package status implements for web the module to publish the status with version and other extras

Index ¶

Variables
func Register(r *gin.Engine, ws *web.Service)
type Status

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// VERSION string on status API
	VERSION string = ""
	// UP function to detect, if API is healthy
	UP func() bool = func() bool {
		return true
	}
	// EXTRAS show more informations in status
	EXTRAS interface{} = nil
)

Functions ¶

func Register ¶

func Register(r *gin.Engine, ws *web.Service)

Register status module @Summary Show Status of current API @Description Show version and status @Tags status @Produce json @Success 200 {object} Status @Failure 400 {object} web.HTTPError @Failure 404 {object} web.HTTPError @Router /api/status [get]

Types ¶

type Status ¶

type Status struct {
	Version string      `json:"version"`
	Up      bool        `json:"up"`
	Extras  interface{} `json:"extras,omitempty"`
}

Status API response

Source Files ¶

View all Source files

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