httpgo

package module

v0.0.0-...-863588f Latest Latest Go to latest Published: Mar 25, 2024 License: MIT Imports: 9 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/pkg6/httpgo

Links

Open Source Insights

README ¶

httpgo

Documentation ¶

Index ¶

Variables
func Bind(req *http.Request, obj any, binding binding.Binding) error
func DefaultBind(req *http.Request, obj any) error
func IsAjax(req *http.Request) bool
func IsSSL(req *http.Request) bool
func IsScript(req *http.Request) bool
func JSONResponse(w http.ResponseWriter, code int, v any) error
func JSONResponseWithCode(w http.ResponseWriter, code int, v any) error
func OKJSONResponse(w http.ResponseWriter, v any) error
func OKResponse(w http.ResponseWriter)
func OKXMLResponse(w http.ResponseWriter, v any) error
func XMLResponse(w http.ResponseWriter, code int, v any) error
func XMLResponseWithCode(w http.ResponseWriter, code int, v any) error
type BaseResponse
type BaseResponseErr

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// BusinessCodeOK represents the business code for success.
	BusinessCodeOK = 0
	// BusinessMsgOK represents the business message for success.
	BusinessMsgOK = "ok"
	// BusinessCodeError represents the business code for error.
	BusinessCodeError = -1

	ResponseContentTypeJSON = "application/json"
	ResponseContentTypeXML  = "application/xml"
)

View Source

var (
	CompileIsScript = []string{
		"curl",
		"wget",
		"collectd",
		"python",
		"urllib",
		"java",
		"jakarta",
		"httpclient",
		"phpcrawl",
		"libwww",
		"perl",
		"go-http",
		"okhttp",
		"lua-resty",
		"winhttp",
		"awesomium",
	}
)

Functions ¶

func Bind ¶

func Bind(req *http.Request, obj any, binding binding.Binding) error

func DefaultBind ¶

func DefaultBind(req *http.Request, obj any) error

func IsAjax ¶

func IsAjax(req *http.Request) bool

func IsSSL ¶

func IsSSL(req *http.Request) bool

func IsScript ¶

func IsScript(req *http.Request) bool

func JSONResponse ¶

func JSONResponse(w http.ResponseWriter, code int, v any) error

func JSONResponseWithCode ¶

func JSONResponseWithCode(w http.ResponseWriter, code int, v any) error

JSONResponseWithCode writes v as json string into w with code.

func OKJSONResponse ¶

func OKJSONResponse(w http.ResponseWriter, v any) error

OKJSONResponse writes v into w with http.StatusOK.

func OKResponse ¶

func OKResponse(w http.ResponseWriter)

OKResponse writes HTTP 200 OK into w.

func OKXMLResponse ¶

func OKXMLResponse(w http.ResponseWriter, v any) error

OKXMLResponse writes v into w with http.StatusOK.

func XMLResponse ¶

func XMLResponse(w http.ResponseWriter, code int, v any) error

func XMLResponseWithCode ¶

func XMLResponseWithCode(w http.ResponseWriter, code int, v any) error

XMLResponseWithCode writes v as xml string into w with code.

Types ¶

type BaseResponse ¶

type BaseResponse[T any] struct {
	// Code represents the business code, not the http status code.
	Code int `json:"code" xml:"code"`
	// Msg represents the business message, if Code = BusinessCodeOK,
	// and Msg is empty, then the Msg will be set to BusinessMsgSuccess.
	Msg string `json:"msg" xml:"msg"`
	// Data represents the business data.
	Data T `json:"data,omitempty" xml:"data,omitempty"`
}

BaseResponse is the base response struct.

type BaseResponseErr ¶

type BaseResponseErr interface {
	error
	Code() int
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
binding
bytesconv
config
errors
json
t

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