grest

README

grest - A full featured REST http handler in go

How-to

package main

import (
	"log"
	"net/http"

	"github.com/xdbsoft/grest"
	"github.com/xdbsoft/grest/rules"
)

func main() {

	cfg := grest.Config{
		OpenIDConnectIssuer: "https://login.okiapps.com/",                                // You may use any OIDC provider (Google, Github, or self hosted)
		DBConnStr:           "user=nestor password=nestor dbname=nestor sslmode=disable", //Connection string to the PostgreSQL database
		Rules: []rules.Rule{
			{
				Path: "test/{userId}/sub/{doc}",
				Read: rules.Allow{
					With: []rules.With{
						{
							Name: "user",
							Path: "test/{userId}",
						},
					},
					IfPath: `path.doc != "private" || path.userId == user.id || with.user.role == "admin"`,
				},
				Write: rules.Allow{
					IfPath:    `path.userId == user.id`,
					IfContent: `content.properties.policy == 'EDITABLE' || with.user.role == "admin"`,
				},
			},
		},
	}

	s, _ := grest.Server(cfg)

	http.Handle("/", s)

	log.Fatal(http.ListenAndServe(":8080", nil))
}

Documentation

Index

• func IsBadRequest(err error) bool
• func IsNotAuthorized(err error) bool
• func IsNotFound(err error) bool
• func Server(cfg Config) (http.Handler, error)
• type BadRequest
• type Config
• type NotAuthorized
• type NotFound

Functions

func IsBadRequest

func IsBadRequest(err error) bool

IsBadRequest returns whether the error cause is that the provided inputs are incorrect

func IsNotAuthorized

func IsNotAuthorized(err error) bool

IsNotAuthorized returns whether the error cause is that there was an attempt to perform a not authorized action

func IsNotFound

func IsNotFound(err error) bool

IsNotFound returns whether the error cause is that something was not found

func Server

func Server(cfg Config) (http.Handler, error)

Server instantiate a new grest server

Types

type BadRequest

type BadRequest interface {
	IsBadRequest() bool
}

BadRequest is the interface that wraps the IsBadRequest method

type Config

type Config struct {
	OpenIDConnectIssuer string
	DBConnStr           string
	Rules               []rules.Rule
}

Config contains all required information for the intialisation of a grest server

type NotAuthorized

type NotAuthorized interface {
	IsNotAuthorized() bool
}

NotAuthorized is the interface that wraps the IsNotAuthorized nethod

type NotFound

type NotFound interface {
	IsNotFound() bool
}

NotFound is the interface that wraps the IsNotFound nethod