users

package

v0.0.0-...-e92ab92 Latest Latest Go to latest Published: Nov 4, 2021 License: MIT Imports: 11 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/stevenferrer/chi-rest

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ErrInvalidRequest(err error) render.Renderer
func ErrRender(err error) render.Renderer
func New(store usermodel.Storer, tokenAuth *jwtauth.JWTAuth) chi.Router
func NewUserListResponse(users []usermodel.User) []render.Renderer
type ErrResponse
- func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error
type UserRequest
- func (ur *UserRequest) Bind(r *http.Request) error
- func (ur *UserRequest) UnmarshalJSON(data []byte) error
type UserResponse
- func NewUserResponse(user usermodel.User) *UserResponse
- func (ur *UserResponse) Render(w http.ResponseWriter, r *http.Request) error

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNotFound = &ErrResponse{HTTPStatusCode: 404, StatusText: "Resource not found"}

Functions ¶

func ErrInvalidRequest ¶

func ErrInvalidRequest(err error) render.Renderer

func ErrRender ¶

func ErrRender(err error) render.Renderer

func New ¶

func New(store usermodel.Storer, tokenAuth *jwtauth.JWTAuth) chi.Router

func NewUserListResponse ¶

func NewUserListResponse(users []usermodel.User) []render.Renderer

Types ¶

type ErrResponse ¶

type ErrResponse struct {
	Err            error `json:"-"` // low-level runtime error
	HTTPStatusCode int   `json:"-"` // http response status code

	StatusText string `json:"status"`          // user-level status message
	AppCode    int64  `json:"code,omitempty"`  // application-specific error code
	ErrorText  string `json:"error,omitempty"` // application-level error message, for debugging
}

ErrResponse renderer type for handling all sorts of errors.

In the best case scenario, the excellent github.com/pkg/errors package helps reveal information on the error, setting it on Err, and in the Render() method, using it to set the application-specific error code in AppCode.

func (*ErrResponse) Render ¶

func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error

type UserRequest ¶

type UserRequest struct {
	*usermodel.User
}

func (*UserRequest) Bind ¶

func (ur *UserRequest) Bind(r *http.Request) error

Bind validates required fields and values

func (*UserRequest) UnmarshalJSON ¶

func (ur *UserRequest) UnmarshalJSON(data []byte) error

type UserResponse ¶

type UserResponse struct {
	*usermodel.User
	Message string `json:"message,omitempty"`
}

func NewUserResponse ¶

func NewUserResponse(user usermodel.User) *UserResponse

func (*UserResponse) Render ¶

func (ur *UserResponse) Render(w http.ResponseWriter, r *http.Request) error

Source Files ¶

View all Source files

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