http

package
v1.10.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 26, 2023 License: MIT Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source
const Binding = "goravel.http"

Variables

View Source
var (
	ConfigFacade      config.Config
	CacheFacade       cache.Cache
	LogFacade         log.Log
	RateLimiterFacade http.RateLimiter
	ValidationFacade  validation.Validation
)

Functions

func Background

func Background() http.Context

func GinResponseMiddleware

func GinResponseMiddleware() httpcontract.Middleware

func NewGinContext

func NewGinContext(ctx *gin.Context) http.Context

func NewGinRequest

func NewGinRequest(ctx *GinContext, log log.Log, validation validatecontract.Validation) httpcontract.Request

func NewGinStatus added in v1.10.2

func NewGinStatus(instance *gin.Context, code int) httpcontract.ResponseSuccess

func NewGinSuccess

func NewGinSuccess(instance *gin.Context) httpcontract.ResponseSuccess

Types

type BodyWriter

type BodyWriter struct {
	gin.ResponseWriter
	// contains filtered or unexported fields
}

func (*BodyWriter) Body

func (w *BodyWriter) Body() *bytes.Buffer

func (*BodyWriter) Write

func (w *BodyWriter) Write(b []byte) (int, error)

func (*BodyWriter) WriteString

func (w *BodyWriter) WriteString(s string) (int, error)

type GinContext

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

func (*GinContext) Context

func (c *GinContext) Context() context.Context

func (*GinContext) Deadline

func (c *GinContext) Deadline() (deadline time.Time, ok bool)

func (*GinContext) Done

func (c *GinContext) Done() <-chan struct{}

func (*GinContext) Err

func (c *GinContext) Err() error

func (*GinContext) Instance

func (c *GinContext) Instance() *gin.Context

func (*GinContext) Request

func (c *GinContext) Request() http.Request

func (*GinContext) Response

func (c *GinContext) Response() http.Response

func (*GinContext) Value

func (c *GinContext) Value(key any) any

func (*GinContext) WithValue

func (c *GinContext) WithValue(key string, value any)

type GinRequest

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

func (*GinRequest) AbortWithStatus

func (r *GinRequest) AbortWithStatus(code int)

func (*GinRequest) AbortWithStatusJson

func (r *GinRequest) AbortWithStatusJson(code int, jsonObj any)

func (*GinRequest) All added in v1.10.2

func (r *GinRequest) All() map[string]any

func (*GinRequest) Bind

func (r *GinRequest) Bind(obj any) error

func (*GinRequest) File

func (r *GinRequest) File(name string) (filesystemcontract.File, error)

func (*GinRequest) Form

func (r *GinRequest) Form(key string, defaultValue ...string) string

func (*GinRequest) FullUrl

func (r *GinRequest) FullUrl() string

func (*GinRequest) Header

func (r *GinRequest) Header(key string, defaultValue ...string) string

func (*GinRequest) Headers

func (r *GinRequest) Headers() http.Header

func (*GinRequest) Host added in v1.10.2

func (r *GinRequest) Host() string

func (*GinRequest) Input

func (r *GinRequest) Input(key string, defaultValue ...string) string

func (*GinRequest) InputBool

func (r *GinRequest) InputBool(key string, defaultValue ...bool) bool

func (*GinRequest) InputInt

func (r *GinRequest) InputInt(key string, defaultValue ...int) int

func (*GinRequest) InputInt64

func (r *GinRequest) InputInt64(key string, defaultValue ...int64) int64

func (*GinRequest) Ip

func (r *GinRequest) Ip() string

func (*GinRequest) Json

func (r *GinRequest) Json(key string, defaultValue ...string) string

func (*GinRequest) Method

func (r *GinRequest) Method() string

func (*GinRequest) Next

func (r *GinRequest) Next()

func (*GinRequest) Origin

func (r *GinRequest) Origin() *http.Request

func (*GinRequest) Path

func (r *GinRequest) Path() string

func (*GinRequest) Queries added in v1.10.2

func (r *GinRequest) Queries() map[string]string

func (*GinRequest) Query

func (r *GinRequest) Query(key string, defaultValue ...string) string

func (*GinRequest) QueryArray

func (r *GinRequest) QueryArray(key string) []string

func (*GinRequest) QueryBool

func (r *GinRequest) QueryBool(key string, defaultValue ...bool) bool

func (*GinRequest) QueryInt

func (r *GinRequest) QueryInt(key string, defaultValue ...int) int

func (*GinRequest) QueryInt64

func (r *GinRequest) QueryInt64(key string, defaultValue ...int64) int64

func (*GinRequest) QueryMap

func (r *GinRequest) QueryMap(key string) map[string]string

func (*GinRequest) Route

func (r *GinRequest) Route(key string) string

func (*GinRequest) RouteInt

func (r *GinRequest) RouteInt(key string) int

func (*GinRequest) RouteInt64

func (r *GinRequest) RouteInt64(key string) int64

func (*GinRequest) Url

func (r *GinRequest) Url() string

func (*GinRequest) Validate

func (r *GinRequest) Validate(rules map[string]string, options ...validatecontract.Option) (validatecontract.Validator, error)

func (*GinRequest) ValidateRequest

func (r *GinRequest) ValidateRequest(request httpcontract.FormRequest) (validatecontract.Errors, error)

type GinResponse

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

func NewGinResponse

func NewGinResponse(instance *gin.Context, origin httpcontract.ResponseOrigin) *GinResponse

func (*GinResponse) Data

func (r *GinResponse) Data(code int, contentType string, data []byte)

func (*GinResponse) Download

func (r *GinResponse) Download(filepath, filename string)

func (*GinResponse) File

func (r *GinResponse) File(filepath string)

func (*GinResponse) Header

func (r *GinResponse) Header(key, value string) httpcontract.Response

func (*GinResponse) Json

func (r *GinResponse) Json(code int, obj any)

func (*GinResponse) Origin

func (*GinResponse) Redirect

func (r *GinResponse) Redirect(code int, location string)

func (*GinResponse) Status added in v1.10.2

func (r *GinResponse) Status(code int) httpcontract.ResponseStatus

func (*GinResponse) String

func (r *GinResponse) String(code int, format string, values ...any)

func (*GinResponse) Success

func (*GinResponse) Writer

func (r *GinResponse) Writer() http.ResponseWriter

type GinStatus added in v1.10.2

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

func (*GinStatus) Data added in v1.10.2

func (r *GinStatus) Data(contentType string, data []byte)

func (*GinStatus) Json added in v1.10.2

func (r *GinStatus) Json(obj any)

func (*GinStatus) String added in v1.10.2

func (r *GinStatus) String(format string, values ...any)

type GinSuccess

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

func (*GinSuccess) Data

func (r *GinSuccess) Data(contentType string, data []byte)

func (*GinSuccess) Json

func (r *GinSuccess) Json(obj any)

func (*GinSuccess) String

func (r *GinSuccess) String(format string, values ...any)

type RateLimiter

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

func NewRateLimiter

func NewRateLimiter() *RateLimiter

func (*RateLimiter) For

func (r *RateLimiter) For(name string, callback func(ctx http.Context) http.Limit)

func (*RateLimiter) ForWithLimits

func (r *RateLimiter) ForWithLimits(name string, callback func(ctx http.Context) []http.Limit)

func (*RateLimiter) Limiter

func (r *RateLimiter) Limiter(name string) func(ctx http.Context) []http.Limit

type ServiceProvider

type ServiceProvider struct {
}

func (*ServiceProvider) Boot

func (http *ServiceProvider) Boot(app foundation.Application)

func (*ServiceProvider) Register

func (http *ServiceProvider) Register(app foundation.Application)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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