realworld

package

v0.0.0-...-973ca76 Latest Latest Go to latest Published: Mar 7, 2020 License: MIT 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

Repository

github.com/at-ishikawa/samples

Links

Open Source Insights

README ¶

Libraries

kelseyhightower/envconfig: Environment variables
gorilla/mux: Routing url
go-cloud/wire: Dependency Injection
go-playground/validator: Validation
sirupsen/logrus: Logging

Documentation ¶

Index ¶

Variables
func GetLogger(ctx context.Context) *logrus.Entry
func NewLogger() *logrus.Logger
func NewRouter(logger *logrus.Logger, userHandler UserHandler) *mux.Router
func WithLogger(ctx context.Context, logger *logrus.Entry) context.Context
type Env
- func NewEnv() (Env, error)
type HTTPServer
- func InjectHTTPServer() (HTTPServer, error)
- func NewHTTPServer(logger *logrus.Logger, env Env, router *mux.Router) HTTPServer
- func (s HTTPServer) Run()
type User
type UserHandler
- func NewUserHandler(validator Validator) UserHandler
- func (h UserHandler) GetUser(w http.ResponseWriter, r *http.Request)
type UserRequest
type Validator
- func NewValidator() (Validator, error)
- func (v *Validator) Validate(req interface{}) (map[string]string, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var Container = wire.NewSet(
	NewEnv,
	NewLogger,
	NewValidator,
	NewUserHandler,
	NewRouter,
	NewHTTPServer, wire.Bind(new(http.Handler), new(mux.Router)))

View Source

var (
	L = logrus.NewEntry(logrus.StandardLogger())
)

Functions ¶

func GetLogger ¶

func GetLogger(ctx context.Context) *logrus.Entry

func NewLogger ¶

func NewLogger() *logrus.Logger

func NewRouter ¶

func NewRouter(logger *logrus.Logger, userHandler UserHandler) *mux.Router

func WithLogger ¶

func WithLogger(ctx context.Context, logger *logrus.Entry) context.Context

Types ¶

type Env ¶

type Env struct {
	Host string `envconfig:"host" default:"127.0.0.1"`
	Port int    `envconfig:"port" default:"8080"`
}

func NewEnv ¶

func NewEnv() (Env, error)

type HTTPServer ¶

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

func InjectHTTPServer ¶

func InjectHTTPServer() (HTTPServer, error)

func NewHTTPServer ¶

func NewHTTPServer(logger *logrus.Logger, env Env, router *mux.Router) HTTPServer

func (HTTPServer) Run ¶

func (s HTTPServer) Run()

type User ¶

type User struct {
	Id int `json:"id" validate:"gte=1,lte=1000"`
}

type UserHandler ¶

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

func NewUserHandler ¶

func NewUserHandler(validator Validator) UserHandler

func (UserHandler) GetUser ¶

func (h UserHandler) GetUser(w http.ResponseWriter, r *http.Request)

type UserRequest ¶

type UserRequest struct {
	User
}

type Validator ¶

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

func NewValidator ¶

func NewValidator() (Validator, error)

func (*Validator) Validate ¶

func (v *Validator) Validate(req interface{}) (map[string]string, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
server

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