webservice

README

webservice

Simple web service framework for golang.

License

MIT

Documentation

Index

• Constants
• Variables
• func GetDataBody(r *http.Request, logger Logger) (data []byte, err error)
• type Config
  • func BuildConfig() *Config
  • func (conf *Config) SetLogger(log interface{})
• type FormData
• type HTTPProxy
  • func BuildHTTPProxy(logger interface{}) HTTPProxy
• type Logger
  • func ConvertLoggerMust(log interface{}) Logger
• type MultiFormData
  • func GetMultiFormData(r *http.Request, logger Logger) (mfd *MultiFormData, err error)
  • func (mfd MultiFormData) FormData(key string) (data *FormData, err error)
  • func (mfd MultiFormData) FormDataMD5() (MD5 string)
• type RequestHandlerFunc
• type ServiceResponse
  • func (sr ServiceResponse) String() string
• type ServiceResponseData
  • func (srd ServiceResponseData) String() string
• type TemplatesManager
• type WebService
  • func StartWebService(conf *Config) WebService

Constants

const (
	// ErrorCodeSuccess indicates success
	ErrorCodeSuccess = 1
)

Variables

var (
	// ErrorNotFound defines not found error
	ErrorNotFound = errors.New("not found")
	// ErrorWrongMethod defines wrong method method error
	ErrorWrongMethod = errors.New("wrong method")
	// ErrorParsedYet defines parsed error
	ErrorParsedYet = errors.New("request has parsed by others")
	// ErrorInvalidArgument defines invalid argument
	ErrorInvalidArgument = errors.New("invalid argument")
)

Functions

func GetDataBody

func GetDataBody(r *http.Request, logger Logger) (data []byte, err error)

GetDataBody get post/put/patch data

Types

type Config

type Config struct {
	WebAddr                  string
	Port                     uint16
	Statics                  map[string]string
	Handlers                 map[string]RequestHandlerFunc
	ReadTimeout              time.Duration
	WriteTimeout             time.Duration
	AuthMap                  map[string]map[string]int
	PagesTempLatesDir        string
	PageGlobPattern          string
	WidgetsTempLatesDir      string
	WidgetGlobPattern        string
	TemplatesRefreshInterval time.Duration
	Logger                   Logger
	Pprof                    bool
	TLSCert                  string
	TLSKey                   string
	UploadsDir               string
}

Config stores web service config

func BuildConfig

func BuildConfig() *Config

BuildConfig builds a default http config which can be convert to https config easy

func (*Config) SetLogger

func (conf *Config) SetLogger(log interface{})

SetLogger set logger to config

type FormData

type FormData struct {
	Name     string
	Data     []byte
	Filename string
}

FormData stores raw value of form data

type HTTPProxy

type HTTPProxy interface {
	ForwardRequest(w http.ResponseWriter, r *http.Request, target *url.URL)
	AgentRequest(r *http.Request, target *url.URL) (*http.Response, error)
}

HTTPProxy defines http proxy interface

func BuildHTTPProxy

func BuildHTTPProxy(logger interface{}) HTTPProxy

BuildHTTPProxy builds http proxy object

type Logger

type Logger interface {
	// SetLevel
	SetLevel(uint8)
	CheckLevel(uint8) bool
	Write(string, bool, ...interface{})
	Debug(...interface{})
	Trace(...interface{})
	Warn(...interface{})
	Error(...interface{})
}

Logger defines logger interface

func ConvertLoggerMust

func ConvertLoggerMust(log interface{}) Logger

ConvertLoggerMust converts a object to Logger interface, build built-in logger if convert failed

type MultiFormData

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

MultiFormData defines multi form data object

func GetMultiFormData

func GetMultiFormData(r *http.Request, logger Logger) (mfd *MultiFormData, err error)

GetMultiFormData reads multi form data of request

func (MultiFormData) FormData

func (mfd MultiFormData) FormData(key string) (data *FormData, err error)

FormData get form date from form data set

func (MultiFormData) FormDataMD5

func (mfd MultiFormData) FormDataMD5() (MD5 string)

FormDataMD5 computes multi form data md5

type RequestHandlerFunc

type RequestHandlerFunc func(http.ResponseWriter, *http.Request, WebService) *ServiceResponse

RequestHandlerFunc defines union http request handler in this frame

 if handler returned nil, frame will not response client;
	otherwise frame will response client with json from return value

type ServiceResponse

type ServiceResponse struct {
	Status     int         `json:"status"`
	Message    interface{} `json:"message"`
	Data       interface{} `json:"data"`
	Indent     bool        `json:"-"`
	StatusCode int         `json:"-"`
}

ServiceResponse defines union web service response

func (ServiceResponse) String

func (sr ServiceResponse) String() string

type ServiceResponseData

type ServiceResponseData struct {
	Status  int             `json:"status"`
	Message string          `json:"message"`
	Data    json.RawMessage `json:"data"`
}

ServiceResponseData defines union web service response data for parsing

func (ServiceResponseData) String

func (srd ServiceResponseData) String() string

type TemplatesManager

type TemplatesManager interface {
	// RenderTemplate render template to http.ResponseWriter
	RenderTemplate(w http.ResponseWriter, name string, data interface{}) error
}

TemplatesManager defines templates manager interface definition

type WebService

type WebService interface {
	// Close close web service
	Close() error
	// ServiceAddr returns service address
	ServiceAddr() string
	// PagesTempLatesDir returns page templates directory of web service
	PagesTempLatesDir() string
	// WidgetsTempLatesDir returns widget templates directory of web service
	WidgetsTempLatesDir() string
	// TemplatesManager get service related templates manager
	TemplatesManager() TemplatesManager
}

WebService defines a web service interface definition

func StartWebService

func StartWebService(conf *Config) WebService

StartWebService starts a web service with config