dogma

package module

v0.0.0-...-4e14a4b Latest Latest Go to latest Published: Aug 27, 2023 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/azurity/go-dogma

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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

Source Files ¶

View all Source files

handle.go

Directories ¶

Path	Synopsis
cmd
generator

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