pyrin

README

pyrin

REST API Framework

Goals

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

Documentation

Index

• func GenerateSpec(routes []Route) (*spec.Server, error)
• func ServeFile(w http.ResponseWriter, r *http.Request, filesystem fs.FS, file string) error
• type ApiHandler
• type ApiHandlerFunc
• type Body
• type Context
• type Error
  • func RouteNotFound() *Error
  • func ValidationError(extra any) *Error
  • func (e *Error) Error() string
• type ErrorType
• type Group
• type Handler
• type NormalHandler
• type NormalHandlerFunc
• type Response
  • func ErrorResponse(err Error) Response
  • func SuccessResponse(data any) Response
• type Route
• type RouteGroup
  • func NewRouteGroup(prefix string) *RouteGroup
  • func (r *RouteGroup) Register(handlers ...Handler)
• 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

Functions

func GenerateSpec

func GenerateSpec(routes []Route) (*spec.Server, error)

func ServeFile

func ServeFile(w http.ResponseWriter, r *http.Request, filesystem fs.FS, file string) error

Types

type ApiHandler

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

type ApiHandlerFunc

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

type Body

type Body interface {
	validate.Validatable
}

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 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"
)

type Group

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

type Handler

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

type NormalHandler

type NormalHandler struct {
	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 Route

type Route struct {
	Name        string
	Path        string
	Method      string
	ErrorTypes  []ErrorType
	Data        any
	Body        any
	RequireForm bool
}

type RouteGroup

type RouteGroup struct {
	Prefix string
	Routes []Route
}

func NewRouteGroup

func NewRouteGroup(prefix string) *RouteGroup

func (*RouteGroup) Register

func (r *RouteGroup) Register(handlers ...Handler)

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