gmrouter

package

v0.100.18 Latest Latest Go to latest Published: Mar 19, 2024 License: GPL-3.0 Imports: 10 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/W3Tools/go-modules

Documentation ¶

Index ¶

Variables
func InitRouter(basePath string, debug bool) *gin.RouterGroup
func RunningApi(host string, port int64) error
type Response
type Router

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultMessage = map[int]string{
	http.StatusOK:                  "OK",
	http.StatusBadRequest:          "BadRequest",
	http.StatusInternalServerError: "Internal Server Error",
	http.StatusUnauthorized:        "Unauthorized",
}

Functions ¶

func InitRouter ¶

func InitRouter(basePath string, debug bool) *gin.RouterGroup

func RunningApi ¶

func RunningApi(host string, port int64) error

Types ¶

type Response ¶

type Response struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}

type Router ¶

type Router struct {
	Api *gin.Context
}

func (*Router) ApiResponse ¶

func (r *Router) ApiResponse(code int, data interface{})

func (*Router) ApiResponseBadRequest ¶

func (r *Router) ApiResponseBadRequest()

func (*Router) ApiResponseInternalServerError ¶

func (r *Router) ApiResponseInternalServerError()

func (*Router) ApiResponseOk ¶

func (r *Router) ApiResponseOk(data interface{})

func (*Router) ApiResponseUnauthorized ¶

func (r *Router) ApiResponseUnauthorized()

func (*Router) BindJSON ¶

func (r *Router) BindJSON(obj any) error

func (*Router) BindQuery ¶

func (r *Router) BindQuery(obj any) error

func (*Router) BindTOML ¶

func (r *Router) BindTOML(obj any) error

func (*Router) BindXML ¶

func (r *Router) BindXML(obj any) error

func (*Router) BindYAML ¶

func (r *Router) BindYAML(obj any) error

func (*Router) LambdaResponse ¶

func (r *Router) LambdaResponse(code int, data interface{}) events.APIGatewayProxyResponse

func (*Router) LambdaResponseBadRequest ¶

func (r *Router) LambdaResponseBadRequest() events.APIGatewayProxyResponse

func (*Router) LambdaResponseInternalServerError ¶

func (r *Router) LambdaResponseInternalServerError() events.APIGatewayProxyResponse

func (*Router) LambdaResponseOk ¶

func (r *Router) LambdaResponseOk(data interface{}) events.APIGatewayProxyResponse

func (*Router) LambdaResponseUnauthorized ¶

func (r *Router) LambdaResponseUnauthorized() events.APIGatewayProxyResponse

func (*Router) NewResponseMessage ¶

func (*Router) NewResponseMessage(code int, data interface{}) Response

func (*Router) RequestHeaderGet ¶

func (r *Router) RequestHeaderGet(key string) string

func (*Router) RequestHeaderSet ¶

func (r *Router) RequestHeaderSet(key string, value string)

func (*Router) ResponseMessageBadRequest ¶

func (r *Router) ResponseMessageBadRequest(data interface{}) Response

func (*Router) ResponseMessageInternalServerError ¶

func (r *Router) ResponseMessageInternalServerError(data interface{}) Response

func (*Router) ResponseMessageOk ¶

func (r *Router) ResponseMessageOk(data interface{}) Response

func (*Router) ResponseMessageUnauthorized ¶

func (r *Router) ResponseMessageUnauthorized(data interface{}) Response

Source Files ¶

View all Source files

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