gorest

README

go-rest

Restful Utilities for Golang

NOTE: this is not a generic utility toolset for Golang. It is tailored to FTC restful API needs.

TODO

Create render package to replace view, providing both JSON and HTML rendering.

Documentation

Index

• func ParseJSON(data io.ReadCloser, v interface{}) error
• func RandomBase64(len int) (string, error)
• func RandomHex(len int) (string, error)
• func Stringify(v interface{}) ([]byte, error)
• type Pagination
  • func GetPagination(req *http.Request) Pagination
  • func NewPagination(p, limit int64) Pagination
  • func (p *Pagination) Normalize()
  • func (p Pagination) Offset() int64
• type Param
  • func GetQueryParam(req *http.Request, key string) Param
  • func NewParam(key, value string) Param
  • func (p Param) ToBool() (bool, error)
  • func (p Param) ToInt() (int64, error)
  • func (p Param) ToString() (string, error)
• type SemVer
  • func ParseSemVer(v string) SemVer
  • func (s SemVer) Compare(other SemVer) int
  • func (s SemVer) Equal(other SemVer) bool
  • func (s SemVer) Larger(other SemVer) bool
  • func (s SemVer) Smaller(other SemVer) bool
• type StringSlice
  • func (x *StringSlice) Scan(src interface{}) error
  • func (x StringSlice) Value() (driver.Value, error)

Functions

func ParseJSON

func ParseJSON(data io.ReadCloser, v interface{}) error

ParseJSON parses input data to struct

func RandomBase64

func RandomBase64(len int) (string, error)

RandomBase64 returns a base64 url encoded, unpadded string of random bytes. len is the length of bytes. It should be the multiple of 3 to get a string without padding: len * 8 / 6. 3 bytes -- 4 chars 6 bytes -- 8 chars 9 bytes -- 12 chars Wechat OAuth code has 32 characters, which is 24 bytes long; Wechat Access Token has 110 chars, which is 82.5 bytes? Wechat Refresh Token has 110 chars. OpenID has 28 chars, which is 21 bytes UnionID has 28 chars.

func RandomHex

func RandomHex(len int) (string, error)

RandomHex generates a random hexadecimal number of 2*len chars

func Stringify

func Stringify(v interface{}) ([]byte, error)

Stringify turn an interface into json string

Types

type Pagination

type Pagination struct {
	Page  int64 `query:"page" schema:"page" json:"page"`          // Which page is requesting data.
	Limit int64 `query:"per_page" schema:"per_page" json:"limit"` // How many items per page.
}

Pagination is used to calculate limit and offset parameter used int sql statement.

func GetPagination

func GetPagination(req *http.Request) Pagination

GetPagination extracts pagination information from query parameter

func NewPagination

func NewPagination(p, limit int64) Pagination

NewPagination creates a new Pagination instance. p is the page number, r is the rows to retrieve.

func (*Pagination) Normalize

func (p *Pagination) Normalize()

func (Pagination) Offset

func (p Pagination) Offset() int64

Offset calculate the offset for SQL.

type Param

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

Param represents a pair of query parameter from URL.

func GetQueryParam

func GetQueryParam(req *http.Request, key string) Param

GetQueryParam get a pair of query parameter from URL.

func NewParam

func NewParam(key, value string) Param

NewParam creates a new instance of Param.

func (Param) ToBool

func (p Param) ToBool() (bool, error)

ToBool converts a query parameter to boolean value.

func (Param) ToInt

func (p Param) ToInt() (int64, error)

ToInt converts the value of a query parameter to int64

func (Param) ToString

func (p Param) ToString() (string, error)

ToString converts a query parameter to string value. Returns error for an empty value.

type SemVer

type SemVer struct {
	Major int
	Minor int
	Patch int
}

SemVer represents a parsed value of semantic version string.

func ParseSemVer

func ParseSemVer(v string) SemVer

ParseSemVer parsed a string into to SemVer

func (SemVer) Compare

func (s SemVer) Compare(other SemVer) int

Compare compares two semantic versions. Returns negative number if s should come before (is smaller) other; 0 if the two are equal; Positive number if s should come after (is larger than) other.

func (SemVer) Equal

func (s SemVer) Equal(other SemVer) bool

Equal tests if two semantic version string are the same.

func (SemVer) Larger

func (s SemVer) Larger(other SemVer) bool

Larger tests whether semantic version a is larger than b

func (SemVer) Smaller

func (s SemVer) Smaller(other SemVer) bool

Smaller tests whether semantic version a is smaller than b.

type StringSlice

type StringSlice []string

StringSlice implments Scanner and Valuer interface for a slice of strings.

func (*StringSlice) Scan

func (x *StringSlice) Scan(src interface{}) error

Scan retrieves a comma-separated string value from SQL to a Go string slice.

func (StringSlice) Value

func (x StringSlice) Value() (driver.Value, error)

Value turns a Go string slice to a comma-sparated string.