misc

package

v0.0.0-...-d6725e5 Latest Latest Go to latest Published: May 3, 2024 License: Apache-2.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

github.com/ZNotify/server

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Alive ¶

func Alive(context *common.Context)

Alive godoc

@Summary      Server Heartbeat
@Id           alive
@Tags         Health
@Description  If the server is alive
@Produce      plain
@Success      204  {string}  string  ""
@Router       /alive [get]

func DocRedirect ¶

func DocRedirect(ctx *common.Context)

DocRedirect godoc

@Summary  Redirect to docs
@Id       docRedirect
@Tags     UI
@Produce  plain
@Success  301  {string}  string  ""
@Router   /docs [get]

func WebIndex ¶

func WebIndex(ctx *common.Context)

WebIndex godoc

@Summary      Web Index
@Description  Provide UI
@Id           webIndex
@Tags         UI
@Produce      html
@Success      200  {string}  string  "html"
@Router       / [get]

Types ¶

This section is empty.

Source Files ¶

View all Source files

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