pyrin

README

pyrin

REST API Framework

Goals

• API Server (Using Echo)
• Schema Validation
• Generate Spec File
• API Client Generation
  • Golang
  • Typescript
• API Docs Generation

Projects Used

• ozzo-validation

Documentation

Index

• Variables
• func Body[T any](c Context) (T, error)
• func ServeFile(c Context, filesystem fs.FS, file string) error
• type ApiHandler
• type ApiHandlerFunc
• type Context
• type Error
  • func BadContentType(expected string) *Error
  • func EmptyBody() *Error
  • func FormValidationError(extra any) *Error
  • func RouteNotFound() *Error
  • func ValidationError(extra any) *Error
  • func (e *Error) Error() string
• type ErrorType
  • func (e ErrorType) String() string
• type Files
  • func FormFiles(c Context, key string) (Files, error)
• type FormApiHandler
• type FormFileSpec
• type FormSpec
• type Group
• type Handler
• type NoContentError
  • func NoContentNotFound() *NoContentError
  • func (e *NoContentError) Error() string
• type NormalHandler
• type NormalHandlerFunc
• type Response
  • func ErrorResponse(err Error) Response
  • func SuccessResponse(data any) Response
• type Router
• type Server
  • func NewServer(config *ServerConfig) *Server
  • func (s *Server) Group(prefix string, m ...echo.MiddlewareFunc) *ServerGroup
  • func (s *Server) Start(addr string) error
• type ServerConfig
• type ServerGroup
  • func (g *ServerGroup) Register(handlers ...Handler)
• type ServerRouter
  • func (r *ServerRouter) Group(prefix string) Group
• type Transformable

Variables

var GlobalErrors = []ErrorType{
	ErrTypeUnknownError,
	ErrTypeRouteNotFound,
	ErrTypeValidationError,
	ErrTypeFormValidationError,
	ErrTypeEmptyBody,
	ErrTypeBadContentType,
}

Functions

func Body

func Body[T any](c Context) (T, error)

func ServeFile

func ServeFile(c Context, filesystem fs.FS, file string) error

Types

type ApiHandler

type ApiHandler struct {
	Name         string
	Method       string
	Path         string
	ResponseType any
	BodyType     any
	Errors       []ErrorType
	Middlewares  []echo.MiddlewareFunc
	HandlerFunc  ApiHandlerFunc
}

type ApiHandlerFunc

type ApiHandlerFunc func(c Context) (any, error)

type Context

type Context interface {
	Request() *http.Request
	Response() http.ResponseWriter
	Param(name string) string
}

type Error

type Error struct {
	Code    int       `json:"code"`
	Type    ErrorType `json:"type"`
	Message string    `json:"message"`
	Extra   any       `json:"extra,omitempty"`
}

func BadContentType

func BadContentType(expected string) *Error

func EmptyBody

func EmptyBody() *Error

func FormValidationError

func FormValidationError(extra any) *Error

func RouteNotFound

func RouteNotFound() *Error

func ValidationError

func ValidationError(extra any) *Error

func (*Error) Error

func (e *Error) Error() string

type ErrorType

type ErrorType string

const (
	ErrTypeUnknownError        ErrorType = "UNKNOWN_ERROR"
	ErrTypeRouteNotFound       ErrorType = "ROUTE_NOT_FOUND"
	ErrTypeValidationError     ErrorType = "VALIDATION_ERROR"
	ErrTypeFormValidationError ErrorType = "FORM_VALIDATION_ERROR"
	ErrTypeEmptyBody           ErrorType = "EMPTY_BODY_ERROR"
	ErrTypeBadContentType      ErrorType = "BAD_CONTENT_TYPE_ERROR"
)

func (ErrorType) String

func (e ErrorType) String() string

type Files

type Files []*multipart.FileHeader

func FormFiles

func FormFiles(c Context, key string) (Files, error)

type FormApiHandler

type FormApiHandler struct {
	Name         string
	Method       string
	Path         string
	ResponseType any
	Spec         FormSpec
	Errors       []ErrorType
	Middlewares  []echo.MiddlewareFunc
	HandlerFunc  ApiHandlerFunc
}

type FormFileSpec

type FormFileSpec struct {
	NumExpected int
}

type FormSpec

type FormSpec struct {
	BodyType any
	Files    map[string]FormFileSpec
}

type Group

type Group interface {
	Register(handlers ...Handler)
}

type Handler

type Handler interface {
	// contains filtered or unexported methods
}

type NoContentError

type NoContentError struct {
	Code int `json:"code"`
}

func NoContentNotFound

func NoContentNotFound() *NoContentError

func (*NoContentError) Error

func (e *NoContentError) Error() string

type NormalHandler

type NormalHandler struct {
	Name        string
	Method      string
	Path        string
	Middlewares []echo.MiddlewareFunc
	HandlerFunc NormalHandlerFunc
}

type NormalHandlerFunc

type NormalHandlerFunc func(c Context) error

type Response

type Response struct {
	Success bool   `json:"success"`
	Data    any    `json:"data,omitempty"`
	Error   *Error `json:"error,omitempty"`
}

func ErrorResponse

func ErrorResponse(err Error) Response

func SuccessResponse

func SuccessResponse(data any) Response

type Router

type Router interface {
	Group(prefix string) Group
}

type Server

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

func NewServer

func NewServer(config *ServerConfig) *Server

func (*Server) Group

func (s *Server) Group(prefix string, m ...echo.MiddlewareFunc) *ServerGroup

func (*Server) Start

func (s *Server) Start(addr string) error

type ServerConfig

type ServerConfig struct {
	RegisterHandlers func(router Router)
	LogName          string
}

type ServerGroup

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

func (*ServerGroup) Register

func (g *ServerGroup) Register(handlers ...Handler)

type ServerRouter

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

func (*ServerRouter) Group

func (r *ServerRouter) Group(prefix string) Group

type Transformable

type Transformable interface {
	Transform()
}