apiframework

package

v0.0.67 Latest Latest Go to latest Published: Aug 28, 2025 License: Apache-2.0 Imports: 18 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 EnforceToken(token string, next http.Handler) http.Handler
func Error(w http.ResponseWriter, r *http.Request, err error, op Operation) error
func GetPathParam(r *http.Request, name string, description string) string
func GetQueryParam(r *http.Request, name, defaultValue, description string) string
func GetVersion() string
func HandleAPIError(resp *http.Response) error
func IsAPIError(err error) bool
func RequestIDMiddleware(next http.Handler) http.Handler
func TokenMiddleware(next http.Handler) http.Handler
func TracingMiddleware(next http.Handler) http.Handler
type APIError
- func (e *APIError) Error() string
type AboutServer
type ContextKey
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")
	ErrImmutableGroup        = errors.New("serverops: immutable group")
	ErrMissingParameter      = errors.New("serverops: missing parameter")
	ErrEmptyRequest          = errors.New("serverops: empty request")
	ErrEmptyRequestBody      = errors.New("serverops: empty request body")
)

View Source

var (
	// ErrBadRequest is a generic error for a 400 Bad Request
	ErrBadRequest = errors.New("serverops: bad request")
	// ErrUnprocessableEntity is a generic error for a 422 Unprocessable Entity
	ErrUnprocessableEntity = errors.New("serverops: unprocessable entity")
	// ErrNotFound is a generic error for a 404 Not Found
	ErrNotFound = errors.New("serverops: not found")
	// ErrConflict is a generic error for a 409 Conflict
	ErrConflict = errors.New("serverops: conflict")
	// ErrForbidden is a generic error for a 403 Forbidden
	ErrForbidden = errors.New("serverops: forbidden")
	// ErrInternalServerError is a generic error for a 500 Internal Server Error
	ErrInternalServerError = errors.New("serverops: internal server error")
	// ErrUnsupportedMediaType is a generic error for a 415 Unsupported Media Type
	ErrUnsupportedMediaType = errors.New("serverops: unsupported media type")
	// ErrUnauthorized is a generic error for a 401 Unauthorized
	ErrUnauthorized = errors.New("serverops: unauthorized")
)

The generic error types for common HTTP status codes

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 EnforceToken ¶

func EnforceToken(token string, next http.Handler) http.Handler

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 GetPathParam ¶

func GetPathParam(r *http.Request, name string, description string) string

GetPathParam retrieves a URL path parameter by name and is used to enforce that all path parameters are documented for the OpenAPI generator. The description argument is not used at runtime but is required for API spec generation.

func GetQueryParam ¶

func GetQueryParam(r *http.Request, name, defaultValue, description string) string

GetQueryParam retrieves a URL query parameter by name. If the parameter is not present, it returns the provided defaultValue. The description is used for OpenAPI generation.

func GetVersion ¶

func GetVersion() string

func HandleAPIError ¶

func HandleAPIError(resp *http.Response) error

HandleAPIError processes error responses from the API

func IsAPIError ¶

func IsAPIError(err error) bool

IsAPIError checks if an error is an APIError

func RequestIDMiddleware ¶

func RequestIDMiddleware(next http.Handler) http.Handler

func TokenMiddleware ¶

func TokenMiddleware(next http.Handler) http.Handler

func TracingMiddleware ¶

func TracingMiddleware(next http.Handler) http.Handler

TracingMiddleware extracts or generates trace and span IDs.

Types ¶

type APIError ¶

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

APIError represents an error response from the API

func (*APIError) Error ¶

func (e *APIError) Error() string

type AboutServer ¶

type AboutServer struct {
	Version        string `json:"version"`
	NodeInstanceID string `json:"nodeInstanceID"`
	Tenancy        string `json:"tenancy"`
}

type ContextKey ¶

type ContextKey string

const (
	ContextTokenKey ContextKey = "token"
)

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