app

package

v0.0.0-...-776aec6 Latest Latest Go to latest Published: Aug 15, 2020 License: AGPL-3.0 Imports: 23 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

This section is empty.

This section is empty.

func BearerToken(token string, db *sqlx.DB) (common.Token, bool)

BearerToken parses a Token given in the Authorization header, with the Bearer prefix.

func GetTokenFull(token string, db *sqlx.DB) (common.Token, bool)

GetTokenFull retrieves an user ID and their token privileges knowing their API token.

func Method(f func(md common.MethodData) common.CodeMessager, privilegesNeeded ...int) fasthttp.RequestHandler

Method wraps an API method to a HandlerFunc.

func PeppyMethod(a func(c *fasthttp.RequestCtx, db *sqlx.DB)) fasthttp.RequestHandler

PeppyMethod generates a method for the peppyapi

func Start(conf common.Conf, dbO *sqlx.DB) *fhr.Router

Start begins taking HTTP connections.

This section is empty.

Path	Synopsis
internals Package internals has methods that suit none of the API packages.	Package internals has methods that suit none of the API packages.
peppy Package peppy implements the osu! API as defined on the osu-api repository wiki (https://github.com/ppy/osu-api/wiki).	Package peppy implements the osu! API as defined on the osu-api repository wiki (https://github.com/ppy/osu-api/wiki).
v1 Package v1 implements the first version of the Ripple API.	Package v1 implements the first version of the Ripple API.
websockets Package websockets implements functionality related to the API websockets.	Package websockets implements functionality related to the API websockets.