Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

rest

package module

Go to main page

Versions in this module

v1

v1.0.1

Nov 19, 2022

v1.0.0

Nov 19, 2022

Changes in this version

+ const DefaultMaxCount

+ const DefaultMaxPeriod

+ const ExecResultName

+ const ExprGUID

+ const ExprID

+ const ExprName

+ const ExprPattern

+ const FlagConvertReplyToJSON

+ const FlagLogUnknownParams

+ const ParamCount

+ const ParamIDs

+ const ParamNames

+ const ParamPeriodFrom

+ const ParamPeriodTo

+ const REany

+ const REempty

+ const REguid

+ const REid

+ const REstatus

+ const ScopeDeleteGUID

+ const ScopeDeleteID

+ const ScopeInsert

+ const ScopeSelectAll

+ const ScopeSelectGUID

+ const ScopeSelectID

+ const ScopeSelectName

+ const ScopeSelectObject

+ const ScopeSelectObjectStatus

+ const ScopeSelectPattern

+ const ScopeSelectStatus

+ const ScopeUpdateGUID

+ const ScopeUpdateID

+ const StatusActive

+ const StatusInactive

+ const StatusProcessed

+ var Log = log.NewFacility("api")

+ func BadRequest(msg string, v ...any) (code int, err error)

+ func CheckPeriod(from time.Time, to time.Time, maxPeriod time.Duration, stdPeriod time.Duration) (normFrom time.Time, normTo time.Time, code int, err error)

+ func Enumerate(e Enumerator) (err error)

+ func Init(cfg any, hh *stdhttp.HTTP, basePath string, defaultDB string, ...) (err error)

+ func InternalServerError(msg string, v ...any) (code int, err error)

+ func ModuleRegistration(handler API) (err error)

+ func ParseTime(s string) (t time.Time, err error)

+ func Start() (err error)

+ type API interface

+ After func(proc *ProcOptions) (result any, code int, err error)

+ Before func(proc *ProcOptions) (result any, code int, err error)

+ Info func() *Info

+ type Enumerator func(path string, info *Info) (err error)

+ type ExecResult struct

+ AffectedRows int64

+ Notice string

+ type FieldDef struct

+ DBname string

+ JSONname string

+ Type reflect.Kind

+ type FuncAfter func(proc *ProcOptions) (result any, code int, err error)

+ type FuncBefore func(proc *ProcOptions) (result any, code int, err error)

+ type FuncInit func(info *Info) (err error)

+ type Info struct

+ After FuncAfter

+ Before FuncBefore

+ CacheLifetime time.Duration

+ Config any

+ DBidx int

+ DBtype string

+ Description string

+ Flags path.Flags

+ Init FuncInit

+ Methods *path.Set

+ Name string

+ Path string

+ QueryPrefix string

+ Summary string

+ type ProcOptions struct

+ Chain *path.Chain

+ Custom any

+ DBqueryName string

+ DBqueryResult any

+ DBqueryVars []any

+ ExecResult sql.Result

+ Fields misc.InterfaceMap

+ H *stdhttp.HTTP

+ ID uint64

+ Info *Info

+ LogFacility *log.Facility

+ LogSrc string

+ Notices *misc.Messages

+ Path string

+ PathParams any

+ Prefix string

+ QueryParams any

+ R *http.Request

+ RawBody []byte

+ RequestBodyNames []string

+ RequestBodyVals []any

+ RequestParams any

+ Scope string

+ W http.ResponseWriter

+ func (proc *ProcOptions) Create() (headers misc.StringMap, result any, code int, err error)

+ func (proc *ProcOptions) Delete() (headers misc.StringMap, result any, code int, err error)

+ func (proc *ProcOptions) Get() (headers misc.StringMap, result any, code int, err error)

+ func (proc *ProcOptions) Others() (headers misc.StringMap, result any, code int, err error)

+ func (proc *ProcOptions) Update() (headers misc.StringMap, result any, code int, err error)

v0

v0.1.13

Sep 8, 2022

v0.1.12

Sep 2, 2022

v0.1.11

Aug 25, 2022

v0.1.10

Jun 2, 2022

v0.1.9

May 12, 2022

v0.1.8

Apr 29, 2022

v0.1.7

Apr 29, 2022

v0.1.6

Feb 5, 2022

v0.1.5

Jan 24, 2022

v0.1.4

Jan 24, 2022

v0.1.3

Jan 24, 2022

v0.1.2

Jan 24, 2022

v0.1.1

Jan 23, 2022

v0.1.0

Sep 9, 2021

Changes in this version

+ func Handler(id uint64, prefix string, path string, w http.ResponseWriter, r *http.Request) (processed bool)

+ func NotAllowed(params *Params) (data interface{}, code int, err error)

+ func NotFound(params *Params) (data interface{}, code int, err error)

+ func NotImplemented(params *Params) (data interface{}, code int, err error)

+ func RegisterEndpoint(url string, endpoint Endpoint, options ...interface{}) (err error)

+ type Endpoint interface

+ Create func(params *Params) (data interface{}, code int, err error)

+ Delete func(params *Params) (data interface{}, code int, err error)

+ Get func(params *Params) (data interface{}, code int, err error)

+ Modify func(params *Params) (data interface{}, code int, err error)

+ Replace func(params *Params) (data interface{}, code int, err error)

+ type Params struct

+ Base string

+ Body []byte

+ ExtraPath []string

+ ID uint64

+ Path string

+ Prefix string

+ R *http.Request

+ W http.ResponseWriter

+ type UseHashForGet bool

Other modules containing this package

github.com/alrusov/rest/v2

github.com/alrusov/rest/v3

github.com/alrusov/rest/v4