api

package

v0.0.0-...-646d846 Latest Latest Go to latest Published: Dec 20, 2022 License: Unlicense Imports: 14 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

Package api is the API server backed by jsonrest-go. It contains routing, handlers, and middleware.

This section is empty.

This section is empty.

func AuthMiddleware(s *Server) jsonrest.Middleware

AuthMiddleware handles account authentication. If a request isn't authenticated, the endpoint handler is not called.

func PanicRecoveryMiddleware() jsonrest.Middleware

PanicRecoveryMiddleware catches and returns any panics that occur in the endpoint.

type Config struct {
	Database *pgxpool.Pool
	Sessions *session.Service

	DumpErrors bool // render full error in response
}

Config is the server configuration and dependencies.

type Server struct {
	// contains filtered or unexported fields
}

Server is an API server.

func NewServer(cfg *Config) *Server

NewServer configures a new API server.

func (s *Server) Protocol() protocol.P

Protocol returns the response protocol helper.

func (s *Server) Repo() *repo.Client

Repo returns the repo client.

func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP implements the http.Handler interface.

func (s *Server) Sessions() *session.Service

Sessions returns the sessions service.

Path	Synopsis
protocol Package protocol translates domain objects to their API response format.	Package protocol translates domain objects to their API response format.