dogma

README

go-dogma

A library & tool for generating web interface definition code from documentation.

Supported output languages & roadmap

• Golang
  • generate type definition code & data validation code
  • typed service definition (use with gorilla/mux)
• Typescript
  • generate type definition code & data validation code
  • typed request method (based on fetch)

Documentation

Index

• func HandleRestFunc[T func(Context, PU, PC) (R, error), PU any, PC any, R any](s *Server, handle T)
• type Context
• type Method
• type ResultBase
• type Server
  • func New(router *mux.Router, sessionMan SessionManager, desc map[reflect.Type]Method, ...) *Server
• type SessionManager

Functions

func HandleRestFunc

func HandleRestFunc[T func(Context, PU, PC) (R, error), PU any, PC any, R any](s *Server, handle T)

Types

type Context

type Context struct {
	Session any
}

type Method

type Method struct {
	Name   string `json:"name"`
	Method string `json:"method"`
}

type ResultBase

type ResultBase struct {
	Message string `json:"message"`
}

type Server

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

func New

func New(router *mux.Router, sessionMan SessionManager, desc map[reflect.Type]Method, logger *log.Logger) *Server

type SessionManager

type SessionManager interface {
	Load(writer http.ResponseWriter, request *http.Request) any
	Store(writer http.ResponseWriter, request *http.Request, session any)
}