api_session

package
v1.0.5 Latest Latest
Warning

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

 Go to latest Published: May 11, 2020 License: BSD-3-Clause Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiMethod 

type ApiMethod string
const (
	ApiMethod_Post   ApiMethod = `POST`
	ApiMethod_Get    ApiMethod = `GET`
	ApiMethod_Option ApiMethod = `OPTIONS`
	ApiMethod_All    ApiMethod = `ALL`
)

type ApiSessionClass 

type ApiSessionClass struct {
	Api            _interface.InterfaceApi
	ResponseWriter http.ResponseWriter
	Request        *http.Request

	JwtHeaderName string
	JwtBody       map[string]interface{}
	UserId        uint64

	Lang       string
	ClientType string // web、android、ios

	Datas map[string]interface{}

	OriginalParams map[string]interface{} // 客户端传过来的原始参数
	Params         map[string]interface{} // 经过前置处理器修饰过的参数

	Defers []func() // api结束后执行的函数
	// contains filtered or unexported fields
}

func NewApiSession 

func NewApiSession() *ApiSessionClass

func (*ApiSessionClass) AddDefer 

func (apiSession *ApiSessionClass) AddDefer(defer_ func())

Add defer handler. Defer handlers will be executed by order at the end of api session.

func (*ApiSessionClass) GetFormValues 

func (apiSession *ApiSessionClass) GetFormValues() (map[string][]string, error)

Read form data from request.

func (*ApiSessionClass) GetHeader 

func (apiSession *ApiSessionClass) GetHeader(name string) string

Read header by key from request headers.

func (*ApiSessionClass) GetMethod 

func (apiSession *ApiSessionClass) GetMethod() string

Get request method (GET, POST, PUT, etc.).

func (*ApiSessionClass) GetPath 

func (apiSession *ApiSessionClass) GetPath() string

Get request path.

func (*ApiSessionClass) GetRemoteAddress 

func (apiSession *ApiSessionClass) GetRemoteAddress() string

Read remote address from request headers.

func (*ApiSessionClass) GetUrlParams 

func (apiSession *ApiSessionClass) GetUrlParams() map[string]string

Read url params from get request.

func (*ApiSessionClass) ReadJSON 

func (apiSession *ApiSessionClass) ReadJSON(jsonObject interface{}) error

Read json data from request body.

func (*ApiSessionClass) ScanParams 

func (apiSession *ApiSessionClass) ScanParams(dest interface{})

func (*ApiSessionClass) SetHeader 

func (apiSession *ApiSessionClass) SetHeader(key string, value string)

Set header of response.

func (*ApiSessionClass) SetStatusCode 

func (apiSession *ApiSessionClass) SetStatusCode(code StatusCode)

Set status code of response.

func (*ApiSessionClass) WriteJson 

func (apiSession *ApiSessionClass) WriteJson(data interface{}) error

Response json body.

func (*ApiSessionClass) WriteText 

func (apiSession *ApiSessionClass) WriteText(text string) error

Response text body.

type ContentTypeValue 

type ContentTypeValue string
const (
	// ContentBinaryHeaderValue header value for binary data.
	ContentTypeValue_Binary ContentTypeValue = "application/octet-stream"
	// ContentHTMLHeaderValue is the  string of text/html response header's content type value.
	ContentTypeValue_HTML ContentTypeValue = "text/html; charset=UTF-8"
	// ContentJSONHeaderValue header value for JSON data.
	ContentTypeValue_JSON ContentTypeValue = "application/json; charset=UTF-8"
	// ContentJavascriptHeaderValue header value for JSONP & Javascript data.
	ContentTypeValue_Javascript ContentTypeValue = "application/javascript; charset=UTF-8"
	// ContentTextHeaderValue header value for Text data.
	ContentTypeValue_Text ContentTypeValue = "text/plain; charset=UTF-8"
	// ContentXMLHeaderValue header value for XML data.
	ContentTypeValue_XML ContentTypeValue = "text/xml; charset=UTF-8"
	// ContentMarkdownHeaderValue custom key/content type, the real is the text/html.
	ContentTypeValue_Markdown ContentTypeValue = "text/markdown; charset=UTF-8"
	// ContentYAMLHeaderValue header value for YAML data.
	ContentTypeValue_YAML ContentTypeValue = "application/x-yaml; charset=UTF-8"
)

type HeaderName 

type HeaderName string
const (
	// ContentTypeHeaderKey is the header key of "Content-Type".
	HeaderName_ContentType HeaderName = "Content-Type"

	// LastModifiedHeaderKey is the header key of "Last-Modified".
	HeaderName_LastModified HeaderName = "Last-Modified"
	// IfModifiedSinceHeaderKey is the header key of "If-Modified-Since".
	HeaderName_IfModifiedSince HeaderName = "If-Modified-Since"
	// CacheControlHeaderKey is the header key of "Cache-Control".
	HeaderName_CacheControl HeaderName = "Cache-Control"
	// ETagHeaderKey is the header key of "ETag".
	HeaderName_ETag HeaderName = "ETag"

	// ContentDispositionHeaderKey is the header key of "Content-Disposition".
	HeaderName_ContentDisposition HeaderName = "Content-Disposition"
	// ContentLengthHeaderKey is the header key of "Content-Length"
	HeaderName_ContentLength HeaderName = "Content-Length"
	// ContentEncodingHeaderKey is the header key of "Content-Encoding".
	HeaderName_ContentEncoding HeaderName = "Content-Encoding"
	// GzipHeaderValue is the header value of "gzip".
	HeaderName_Gzip HeaderName = "gzip"
	// AcceptEncodingHeaderKey is the header key of "Accept-Encoding".
	HeaderName_AcceptEncoding HeaderName = "Accept-Encoding"
	// VaryHeaderKey is the header key of "Vary".
	HeaderName_Vary HeaderName = "Vary"
)

type StatusCode 

type StatusCode int
const (
	StatusCode_Continue           StatusCode = 100 // RFC 7231, 6.2.1
	StatusCode_SwitchingProtocols StatusCode = 101 // RFC 7231, 6.2.2
	StatusCode_Processing         StatusCode = 102 // RFC 2518, 10.1

	StatusCode_OK                   StatusCode = 200 // RFC 7231, 6.3.1
	StatusCode_Created              StatusCode = 201 // RFC 7231, 6.3.2
	StatusCode_Accepted             StatusCode = 202 // RFC 7231, 6.3.3
	StatusCode_NonAuthoritativeInfo StatusCode = 203 // RFC 7231, 6.3.4
	StatusCode_NoContent            StatusCode = 204 // RFC 7231, 6.3.5
	StatusCode_ResetContent         StatusCode = 205 // RFC 7231, 6.3.6
	StatusCode_PartialContent       StatusCode = 206 // RFC 7233, 4.1
	StatusCode_MultiStatus          StatusCode = 207 // RFC 4918, 11.1
	StatusCode_AlreadyReported      StatusCode = 208 // RFC 5842, 7.1
	StatusCode_IMUsed               StatusCode = 226 // RFC 3229, 10.4.1

	StatusCode_MultipleChoices  StatusCode = 300 // RFC 7231, 6.4.1
	StatusCode_MovedPermanently StatusCode = 301 // RFC 7231, 6.4.2
	StatusCode_Found            StatusCode = 302 // RFC 7231, 6.4.3
	StatusCode_SeeOther         StatusCode = 303 // RFC 7231, 6.4.4
	StatusCode_NotModified      StatusCode = 304 // RFC 7232, 4.1
	StatusCode_UseProxy         StatusCode = 305 // RFC 7231, 6.4.5

	StatusCode_TemporaryRedirect StatusCode = 307 // RFC 7231, 6.4.7
	StatusCode_PermanentRedirect StatusCode = 308 // RFC 7538, 3

	StatusCode_BadRequest                   StatusCode = 400 // RFC 7231, 6.5.1
	StatusCode_Unauthorized                 StatusCode = 401 // RFC 7235, 3.1
	StatusCode_PaymentRequired              StatusCode = 402 // RFC 7231, 6.5.2
	StatusCode_Forbidden                    StatusCode = 403 // RFC 7231, 6.5.3
	StatusCode_NotFound                     StatusCode = 404 // RFC 7231, 6.5.4
	StatusCode_MethodNotAllowed             StatusCode = 405 // RFC 7231, 6.5.5
	StatusCode_NotAcceptable                StatusCode = 406 // RFC 7231, 6.5.6
	StatusCode_ProxyAuthRequired            StatusCode = 407 // RFC 7235, 3.2
	StatusCode_RequestTimeout               StatusCode = 408 // RFC 7231, 6.5.7
	StatusCode_Conflict                     StatusCode = 409 // RFC 7231, 6.5.8
	StatusCode_Gone                         StatusCode = 410 // RFC 7231, 6.5.9
	StatusCode_LengthRequired               StatusCode = 411 // RFC 7231, 6.5.10
	StatusCode_PreconditionFailed           StatusCode = 412 // RFC 7232, 4.2
	StatusCode_RequestEntityTooLarge        StatusCode = 413 // RFC 7231, 6.5.11
	StatusCode_RequestURITooLong            StatusCode = 414 // RFC 7231, 6.5.12
	StatusCode_UnsupportedMediaType         StatusCode = 415 // RFC 7231, 6.5.13
	StatusCode_RequestedRangeNotSatisfiable StatusCode = 416 // RFC 7233, 4.4
	StatusCode_ExpectationFailed            StatusCode = 417 // RFC 7231, 6.5.14
	StatusCode_Teapot                       StatusCode = 418 // RFC 7168, 2.3.3
	StatusCode_MisdirectedRequest           StatusCode = 421 // RFC 7540, 9.1.2
	StatusCode_UnprocessableEntity          StatusCode = 422 // RFC 4918, 11.2
	StatusCode_Locked                       StatusCode = 423 // RFC 4918, 11.3
	StatusCode_FailedDependency             StatusCode = 424 // RFC 4918, 11.4
	StatusCode_TooEarly                     StatusCode = 425 // RFC 8470, 5.2.
	StatusCode_UpgradeRequired              StatusCode = 426 // RFC 7231, 6.5.15
	StatusCode_PreconditionRequired         StatusCode = 428 // RFC 6585, 3
	StatusCode_TooManyRequests              StatusCode = 429 // RFC 6585, 4
	StatusCode_RequestHeaderFieldsTooLarge  StatusCode = 431 // RFC 6585, 5
	StatusCode_UnavailableForLegalReasons   StatusCode = 451 // RFC 7725, 3

	StatusCode_InternalServerError           StatusCode = 500 // RFC 7231, 6.6.1
	StatusCode_NotImplemented                StatusCode = 501 // RFC 7231, 6.6.2
	StatusCode_BadGateway                    StatusCode = 502 // RFC 7231, 6.6.3
	StatusCode_ServiceUnavailable            StatusCode = 503 // RFC 7231, 6.6.4
	StatusCode_GatewayTimeout                StatusCode = 504 // RFC 7231, 6.6.5
	StatusCode_HTTPVersionNotSupported       StatusCode = 505 // RFC 7231, 6.6.6
	StatusCode_VariantAlsoNegotiates         StatusCode = 506 // RFC 2295, 8.1
	StatusCode_InsufficientStorage           StatusCode = 507 // RFC 4918, 11.5
	StatusCode_LoopDetected                  StatusCode = 508 // RFC 5842, 7.2
	StatusCode_NotExtended                   StatusCode = 510 // RFC 2774, 7
	StatusCode_NetworkAuthenticationRequired StatusCode = 511 // RFC 6585, 6
)

Source Files

View all Source files

Directories

Path Synopsis
type module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.