restserver

package

v0.0.3 Latest Latest Go to latest Published: Aug 13, 2021 License: MIT Imports: 24 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/n-creativesystem/rbns

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func New(opts ...Option) *gin.Engine
func Render(c *gin.Context, code int, obj protoiface.MessageV1)
func WithDebug(conf *config)
func WriteJSON(w http.ResponseWriter, obj protoiface.MessageV1) error
type Error
- func NewError(code int, message, description string) *Error
- func (e *Error) Copy() Error
- func (e *Error) Error() string
type JSON
- func (r JSON) Render(w http.ResponseWriter) (err error)
- func (r JSON) WriteContentType(w http.ResponseWriter)
type Option
- func WithUI(enabled bool, prefix, root string, indexes bool, baseURL string) Option
- func WithWhiteList(whitelistIp string) Option

Constants ¶

View Source

const (
	DefaultMaxBufferSize int64 = 1024 * 1024
)

View Source

const INDEX = "index.html"

Variables ¶

View Source

var (
	ErrInvalidRequestParameter = NewError(int(reqParamErr), "Invalid request parameter", "")
	ErrInvalidRequestBody      = NewError(int(reqBodyErr), "Invalid request body", "")
)

View Source

var (
	ErrInvalidWhence    = errors.New("invalid whence")
	ErrNegativePosition = errors.New("negative position")
	ErrMaxSizeExceeded  = errors.New("max size exceeded")
)

Functions ¶

func New ¶

func New(opts ...Option) *gin.Engine

New is *gin.Engine

Endpoints base is `/api/v1/`

• /permissions

• /roles

• /organizations

• /users

func Render ¶

func Render(c *gin.Context, code int, obj protoiface.MessageV1)

func WithDebug ¶

func WithDebug(conf *config)

func WriteJSON ¶

func WriteJSON(w http.ResponseWriter, obj protoiface.MessageV1) error

Types ¶

type Error ¶

type Error struct {
	Code        int    `json:"code"`
	Message     string `json:"message"`
	Description string `json:"description"`
}

func NewError ¶

func NewError(code int, message, description string) *Error

func (*Error) Copy ¶

func (e *Error) Copy() Error

func (*Error) Error ¶

func (e *Error) Error() string

type JSON ¶

type JSON struct {
	Data protoiface.MessageV1
}

func (JSON) Render ¶

func (r JSON) Render(w http.ResponseWriter) (err error)

func (JSON) WriteContentType ¶

func (r JSON) WriteContentType(w http.ResponseWriter)

type Option ¶

type Option func(conf *config)

func WithUI ¶

func WithUI(enabled bool, prefix, root string, indexes bool, baseURL string) Option

func WithWhiteList ¶

func WithWhiteList(whitelistIp string) Option

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
file
static
req
res

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