apiframework

package

v0.0.4 Latest Latest Go to latest Published: Aug 5, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Details

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

Repository

github.com/contenox/runtime

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Decode[T any](r *http.Request) (T, error)
func Encode[T any](w http.ResponseWriter, _ *http.Request, status int, v T) error
func Error(w http.ResponseWriter, r *http.Request, err error, op Operation) error
func HandleAPIError(resp *http.Response) error
func IsAPIError(err error) bool
func RequestIDMiddleware(next http.Handler) http.Handler
type APIError
- func (e *APIError) Error() string
type Operation

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrEncodeInvalidJSON      = errors.New("serverops: encoding failing, invalid json")
	ErrDecodeInvalidJSON      = errors.New("serverops: decoding failing, invalid json")
	ErrDecodeInvalidYAML      = errors.New("serverops: decoding failing, invalid yaml")
	ErrDecodeBase64           = errors.New("serverops: decoding failing, invalid base64 data")
	ErrUnsupportedContentType = errors.New("serverops: unsupported content type for decoding")
	ErrReadingRequestBody     = errors.New("serverops: failed to read request body")
	ErrMalformedContentType   = errors.New("serverops: malformed Content-Type header")
)

View Source

var (
	ErrInvalidParameterValue = errors.New("serverops: invalid parameter value type")
	ErrBadPathValue          = errors.New("serverops: bad path value")
	ErrImmutableModel        = errors.New("serverops: immutable model")
	ErrImmutablePool         = errors.New("serverops: immutable pool")
	ErrMissingParameter      = errors.New("serverops: missing parameter")
	ErrEmptyRequest          = errors.New("serverops: empty request")
	ErrEmptyRequestBody      = errors.New("serverops: empty request body")
	ErrBadRequest            = errors.New("serverops: bad request")
	ErrUnprocessableEntity   = errors.New("serverops: unprocessable entity")
)

View Source

var ErrFileEmpty = errors.New("serverops: file cannot be empty")

ErrFileEmpty indicates an attempt to upload an empty file.

View Source

var ErrFileSizeLimitExceeded = errors.New("serverops: file size limit exceeded")

ErrFileSizeLimitExceeded indicates the specific file exceeded its allowed size limit.

View Source

var ErrInvalidChain = errors.New("invalid chain definition")

Functions ¶

func Decode ¶

func Decode[T any](r *http.Request) (T, error)

func Encode ¶

func Encode[T any](w http.ResponseWriter, _ *http.Request, status int, v T) error

func Error ¶

func Error(w http.ResponseWriter, r *http.Request, err error, op Operation) error

Error sends a JSON-encoded error response with an appropriate status code

func HandleAPIError ¶ added in v0.0.4

func HandleAPIError(resp *http.Response) error

HandleAPIError processes error responses from the API

func IsAPIError ¶ added in v0.0.4

func IsAPIError(err error) bool

IsAPIError checks if an error is an APIError

func RequestIDMiddleware ¶

func RequestIDMiddleware(next http.Handler) http.Handler

Types ¶

type APIError ¶ added in v0.0.4

type APIError struct {
	ErrorProperty string `json:"error"`
}

APIError represents an error response from the API

func (*APIError) Error ¶ added in v0.0.4

func (e *APIError) Error() string

type Operation ¶

type Operation uint16

const (
	CreateOperation Operation = iota
	GetOperation
	UpdateOperation
	DeleteOperation
	ListOperation
	AuthorizeOperation
	ServerOperation
	ExecuteOperation
)

Source Files ¶

View all Source files

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