rex

package module
v1.8.5 Latest Latest
Warning

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

Go to latest
Published: Dec 15, 2022 License: MIT Imports: 24 Imported by: 1

README

REX

GoDoc GoReport MIT

REX provides a query/mutation style API server in Golang, noREST.

Installing

go get -u github.com/ije/rex

Example

package main

import (
  "log"
  "github.com/ije/rex"
)

func main() {
  // use middlewares
  rex.Use(
    rex.Logger(log.Default()),
    rex.Cors(rex.CorsAllowAll()),
    rex.Compress(),
  )

  // GET /*
  rex.Query("*", func(ctx *rex.Context) interface{} {
    return rex.HTML(
      "<h1>My Blog</h1><ul>{{range .}}<li>{{.Title}}</li>{{end}}</ul>",
      blogs.All(),
    )
  })

  // GET /post/123 => Blog JSON
  rex.Query("post/*", func(ctx *rex.Context) interface{} {
    blog, ok := blogs.Get(ctx.Path.RequireSegment(1))
    if !ok {
      return &rex.Error{404, "blog not found"}
    }
    return blog
  })

  // POST /add-blog {"title": "Hello World"} => Blog JSON
  rex.Mutation("add-blog", func(ctx *rex.Context) interface{} {
    blog := NewBlog(ctx.Form.Value("title"))
    blogs.Add(blog)
    return blog
  })

  // Starts the server
  rex.Start(8080)
}

Documentation

Overview

Package rex provides a simple & light-weight REST server in golang

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Content added in v1.0.0

func Content(name string, mtime time.Time, r io.ReadSeeker) *contentful

Content replies to the request using the content in the provided ReadSeeker.

func FS added in v1.0.1

func FS(root string, fallback string) interface{}

FS replies to the request with the contents of the file system rooted at root.

func File added in v1.0.0

func File(name string) *contentful

File replies to the request using the file content.

func HTML added in v1.0.0

func HTML(html string) *contentful

HTML replies to the request with a html content.

func Mutation added in v1.0.0

func Mutation(endpoint string, handles ...Handle)

Mutation adds a mutation api

func Query added in v1.0.0

func Query(endpoint string, handles ...Handle)

Query adds a query api

func Redirect added in v1.0.0

func Redirect(url string, status int) interface{}

Redirect replies to the request with a redirect to url, which may be a path relative to the request path.

func Render added in v1.0.0

func Render(t Template, data interface{}) interface{}

Render renders the template with the given data.

func Serve

func Serve(config ServerConfig) chan error

Serve serves a rex server.

func Start added in v0.9.0

func Start(port uint16) chan error

Start starts a REX server.

func StartAutoTLS added in v0.9.0

func StartAutoTLS(port uint16, hosts ...string) chan error

StartAutoTLS starts a REX server with autocert powered by Let's Encrypto SSL

func StartTLS added in v0.9.0

func StartTLS(port uint16, certFile string, keyFile string) chan error

StartTLS starts a REX server with TLS.

func Status added in v1.1.1

func Status(status int, payload interface{}) *statusPlayload

Status replies to the request using the payload in the status.

func Use added in v0.9.0

func Use(middlewares ...Handle)

Use appends middlewares to current APIS middleware stack.

Types

type ACLUser added in v0.8.1

type ACLUser interface {
	Permissions() []string
}

A ACLUser interface contains the Permissions method that returns the permission IDs

type AutoTLSConfig added in v0.4.0

type AutoTLSConfig struct {
	AcceptTOS bool           `json:"acceptTOS"`
	Hosts     []string       `json:"hosts"`
	CacheDir  string         `json:"cacheDir"`
	Cache     autocert.Cache `json:"-"`
}

AutoTLSConfig contains options to support autocert by Let's Encrypto SSL.

type CORS

type CORS struct {
	// AllowedOrigins is a list of origins a cross-domain request can be executed from.
	// If the special "*" value is present in the list, all origins will be allowed.
	// An origin may contain a wildcard (*) to replace 0 or more characters
	// (i.e.: http://*.domain.com). Usage of wildcards implies a small performance penalty.
	// Only one wildcard can be used per origin.
	// Default value is ["*"]
	AllowedOrigins []string
	// AllowOriginFunc is a custom function to validate the origin. It take the origin
	// as argument and returns true if allowed or false otherwise. If this option is
	// set, the content of AllowedOrigins is ignored.
	AllowOriginFunc func(origin string) bool
	// AllowOriginRequestFunc is a custom function to validate the origin. It takes the HTTP Request object and the origin as
	// argument and returns true if allowed or false otherwise. If this option is set, the content of `AllowedOrigins`
	// and `AllowOriginFunc` is ignored.
	AllowOriginRequestFunc func(r *http.Request, origin string) bool
	// AllowedMethods is a list of methods the client is allowed to use with
	// cross-domain requests. Default value is simple methods (HEAD, GET and POST).
	AllowedMethods []string
	// AllowedHeaders is list of non simple headers the client is allowed to use with
	// cross-domain requests.
	// If the special "*" value is present in the list, all headers will be allowed.
	// Default value is [] but "Origin" is always appended to the list.
	AllowedHeaders []string
	// ExposedHeaders indicates which headers are safe to expose to the API of a CORS
	// API specification
	ExposedHeaders []string
	// MaxAge indicates how long (in seconds) the results of a preflight request
	// can be cached
	MaxAge int
	// AllowCredentials indicates whether the request can include user credentials like
	// cookies, HTTP authentication or client side SSL certificates.
	AllowCredentials bool
	// OptionsPassthrough instructs preflight to let other potential next handlers to
	// process the OPTIONS method. Turn this on if your application handles OPTIONS.
	OptionsPassthrough bool
	// Provides a status code to use for successful OPTIONS requests.
	// Default value is http.StatusNoContent (204).
	OptionsSuccessStatus int
	// Debugging flag adds additional output to debug server side CORS issues
	Debug bool
}

CORS is a configuration container to setup the CORS middleware.

func CorsAllowAll added in v1.8.1

func CorsAllowAll() CORS

CorsAllowAll create a new Cors handler with permissive configuration allowing all origins with all standard methods with any header and credentials.

type Context

type Context struct {
	W     http.ResponseWriter
	R     *http.Request
	Path  *Path
	Form  *Form
	Store *Store
	// contains filtered or unexported fields
}

A Context to handle http requests.

func (*Context) ACLUser added in v0.6.0

func (ctx *Context) ACLUser() ACLUser

ACLUser returns the acl user

func (*Context) AddHeader added in v0.1.5

func (ctx *Context) AddHeader(key string, value string)

AddHeader adds the key, value pair to the header of response writer.

func (*Context) BasicAuthUser added in v0.5.0

func (ctx *Context) BasicAuthUser() string

BasicAuthUser returns the BasicAuth username

func (*Context) Cookie

func (ctx *Context) Cookie(name string) (cookie *http.Cookie, err error)

Cookie returns the cookie by name.

func (*Context) DeleteHeader added in v0.14.0

func (ctx *Context) DeleteHeader(key string)

DeleteHeader deletes the values associated with key.

func (*Context) EnableCompression added in v1.0.2

func (ctx *Context) EnableCompression()

EnableCompression enables the compression method based on the Accept-Encoding header

func (*Context) RemoteIP

func (ctx *Context) RemoteIP() string

RemoteIP returns the remote client IP.

func (*Context) RemoveCookie

func (ctx *Context) RemoveCookie(cookie *http.Cookie)

RemoveCookie removes the cookie.

func (*Context) RemoveCookieByName added in v0.8.0

func (ctx *Context) RemoveCookieByName(name string)

RemoveCookieByName removes the cookie by name.

func (*Context) Session

func (ctx *Context) Session() *Session

Session returns the session if it is undefined then create a new one.

func (*Context) SetACLUser added in v0.9.2

func (ctx *Context) SetACLUser(user ACLUser)

SetACLUser sets the acl user

func (*Context) SetCookie

func (ctx *Context) SetCookie(cookie *http.Cookie)

SetCookie sets a cookie.

func (*Context) SetHeader added in v0.1.5

func (ctx *Context) SetHeader(key string, value string)

SetHeader sets the header of response writer entries associated with key to the single element value.

type Error added in v1.0.0

type Error struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
}

Error defines an error with status.

func Err added in v1.3.0

func Err(status int, v ...string) *Error

type Form added in v0.11.0

type Form struct {
	R *http.Request
}

A Form to handle request form data.

func (*Form) File added in v0.11.0

func (form *Form) File(key string) (multipart.File, *multipart.FileHeader, error)

File returns the first file for the provided form key.

func (*Form) Float added in v0.11.1

func (form *Form) Float(key string) (float64, error)

Float returns the form value as float

func (*Form) Has added in v1.6.0

func (form *Form) Has(key string) bool

Has checks the value for the key whether exists.

func (*Form) Int added in v0.11.1

func (form *Form) Int(key string) (int64, error)

Int returns the form value as integer

func (*Form) Require added in v0.11.0

func (form *Form) Require(key string) string

Require requires a value

func (*Form) RequireFloat added in v0.11.0

func (form *Form) RequireFloat(key string) float64

RequireFloat requires a value as float

func (*Form) RequireInt added in v0.11.0

func (form *Form) RequireInt(key string) int64

RequireInt requires a value as int

func (*Form) Value added in v0.11.0

func (form *Form) Value(key string) string

Value returns the first value for the named component of the POST, PATCH, or PUT request body, or returns the first value for the named component of the request url query.

type Handle added in v0.8.0

type Handle func(ctx *Context) interface{}

Handle defines the API handle

func ACL added in v0.5.1

func ACL(permissions ...string) Handle

ACL returns a ACL middleware.

func AccessLogger added in v0.13.2

func AccessLogger(logger Logger) Handle

AccessLogger returns a AccessLogger middleware to sets the access logger.

func BasicAuth added in v0.4.0

func BasicAuth(auth func(name string, secret string) (ok bool, err error)) Handle

BasicAuth returns a Basic HTTP Authorization middleware.

func BasicAuthWithRealm added in v0.8.0

func BasicAuthWithRealm(realm string, auth func(name string, secret string) (ok bool, err error)) Handle

BasicAuthWithRealm returns a Basic HTTP Authorization middleware with realm.

func Compression added in v1.8.0

func Compression() Handle

Compression is REX middleware to enable compress by content type and client `Accept-Encoding`

func Cors added in v0.13.2

func Cors(c CORS) Handle

Cors returns a Cors middleware to handle CORS.

func ErrorLogger added in v0.13.2

func ErrorLogger(logger Logger) Handle

ErrorLogger returns a ErrorLogger middleware to sets the error logger.

func Header(key string, value string) Handle

Header is REX middleware to set http header

func SIDStore added in v0.6.2

func SIDStore(sidStore session.SIDStore) Handle

SIDStore returns a SIDStore middleware to sets sid store for session.

func SessionPool added in v0.9.4

func SessionPool(pool session.Pool) Handle

SessionPool returns a SessionPool middleware to set the session pool.

type Handler added in v1.7.0

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

Handler is a query/mutation style API http Handler

func Default added in v0.13.4

func Default() *Handler

Default returns the default REST

func Prefix added in v1.4.0

func Prefix(prefix string) *Handler

Prefix adds prefix for each api path, like "v2"

func (*Handler) Mutation added in v1.7.0

func (a *Handler) Mutation(endpoint string, handles ...Handle)

Mutation adds a mutation api

func (*Handler) Prefix added in v1.7.0

func (a *Handler) Prefix(prefix string) *Handler

Prefix adds prefix for each api path, like "v2"

func (*Handler) Query added in v1.7.0

func (a *Handler) Query(endpoint string, handles ...Handle)

Query adds a query api

func (*Handler) ServeHTTP added in v1.7.0

func (a *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements the http Handler.

func (*Handler) Use added in v1.7.0

func (a *Handler) Use(middlewares ...Handle)

Use appends middlewares to current APIS middleware stack.

type Logger added in v0.5.0

type Logger interface {
	Printf(format string, v ...interface{})
}

A Logger interface contains the Printf method.

type Path added in v1.2.0

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

A Form to handle request path.

func (*Path) GetSegment added in v1.2.1

func (path *Path) GetSegment(index int) string

Segment returns the path segment by the index

func (*Path) RequireSegment added in v1.2.0

func (path *Path) RequireSegment(index int) string

RequireSegment requires a path segment by the index

func (*Path) Segments added in v1.2.1

func (path *Path) Segments() []string

Len returns the path segments

func (*Path) String added in v1.2.0

func (path *Path) String() string

String returns the path as string

type ServerConfig added in v0.12.5

type ServerConfig struct {
	Host           string    `json:"host"`
	Port           uint16    `json:"port"`
	TLS            TLSConfig `json:"tls"`
	ReadTimeout    uint32    `json:"readTimeout"`
	WriteTimeout   uint32    `json:"writeTimeout"`
	MaxHeaderBytes uint32    `json:"maxHeaderBytes"`
}

ServerConfig contains options to run the REX server.

type Session added in v0.5.1

type Session struct {
	session.Session
}

Session handles sessions for Context

func (*Session) Delete added in v0.5.1

func (s *Session) Delete(key string)

Delete removes a session value

func (*Session) Flush added in v0.5.1

func (s *Session) Flush()

Flush flushes all session values

func (*Session) Get added in v0.5.1

func (s *Session) Get(key string) []byte

Get returns a session value

func (*Session) Has added in v0.5.1

func (s *Session) Has(key string) bool

Has checks a value exists

func (*Session) SID added in v0.5.1

func (s *Session) SID() string

SID returns the sid

func (*Session) Set added in v0.5.1

func (s *Session) Set(key string, value []byte)

Set sets a session value

type Store added in v1.1.0

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

A Store to store values.

func (*Store) Get added in v1.1.0

func (s *Store) Get(key string) (interface{}, bool)

Get returns the value stored in the store for a key, or nil if no value is present.

func (*Store) Set added in v1.1.0

func (s *Store) Set(key string, value interface{})

Set sets the value for a key.

type TLSConfig added in v0.9.0

type TLSConfig struct {
	Port         uint16        `json:"port"`
	CertFile     string        `json:"certFile"`
	KeyFile      string        `json:"keyFile"`
	AutoTLS      AutoTLSConfig `json:"autotls"`
	AutoRedirect bool          `json:"autoRedirect"`
}

TLSConfig contains options to support https.

type Template added in v0.5.8

type Template interface {
	Name() string
	Execute(wr io.Writer, data interface{}) error
}

Directories

Path Synopsis
examples
static command
todos command

Jump to

Keyboard shortcuts

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