api

package

v0.0.0-...-ad3dd47 Latest Latest Go to latest Published: Jan 17, 2021 License: AGPL-3.0-or-later Imports: 17 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 GenerateToken(seed string) string

GenerateToken : generate user token based on the seed (eg : email)

func HashPassword(password string) (string, error)

HashPassword : just bcrypt stuff.

func JwtVerify(a *Server) func(http.Handler) http.Handler

JwtVerify : Token verification

type Response struct {
	HTTPCode int    `example:"403"`
	Content  string `example:"Token invalid."`
}

Response : Used to reply to http query

type Server struct {
	Router    *mux.Router
	APIRouter *mux.Router
	DB        *gorm.DB
	Conf      *utils.Conf
}

Server : Struct for App (http server) configuration in the config.ini file

func (a *Server) Initialize(conf *utils.Conf)

Initialize : Initialize the mux router and the routes

func (a *Server) Run(conf *utils.Conf)

Run : Start the HTTP Server

Path	Synopsis
types