zeta

README

Introduce

A framework that helps other major Web frameworks work better.

Feature

Zeta has the following features:

• less invasive
• use simple
• easily plug
• extensible
• practice is the sole criterion for testing truth

Usage

The sample of Gin:

package main

import (
	"context"
	"fmt"
	"github.com/gin-gonic/gin"
	"github.com/zeta-io/ginx"
	"github.com/zeta-io/zeta"
)

func list(context context.Context, c1 *context.Context, args struct{
	Name string `json:"name" param:"query,name" validator:"required"`
}) (string, error){
	fmt.Println(args.Name)
	return "hello zeta", nil
}

func main() {
	router := zeta.Router("/api/:version/users")
	router.Get("", list)

	e := zeta.New(router, ginx.New(gin.New())).Run(":8080")
	if e != nil{
		panic(e)
	}
}

More samples.

Driver

• Ginx: Gin driver for zeta.

Documentation

Overview

Router

* 2 * @Author: Nico 3 * @Date: 2020/11/8 17:53 4

Index

• type ContentType
• type Driver
• type HandlerFunc
• type JSON
  • func DefaultJSON() JSON
• type Mapping
  • func (m *Mapping) Method() Method
  • func (m *Mapping) Middleware() []HandlerFunc
  • func (m *Mapping) Url() string
• type Method
• type Option
• type Serial
  • func DefaultSerial(jsons ...JSON) Serial
• type Validator
  • func DefaultValidator() Validator
• type Zeta
  • func New(d Driver, options ...Option) *Zeta
  • func (z *Zeta) Complete()
  • func (r Zeta) Group(url string, middleware ...HandlerFunc) *group
  • func (r Zeta) Handle(method Method, url string, middleware ...HandlerFunc) *router
  • func (r Zeta) Mappings() []Mapping
  • func (r Zeta) Middleware() []HandlerFunc
  • func (r Zeta) Option(z *Zeta)
  • func (z *Zeta) Options(options ...Option) *Zeta
  • func (z *Zeta) Run(addr ...string) error
  • func (r Zeta) Use(middleware ...HandlerFunc) *router

Types

type ContentType

type ContentType string

const (
	ContentTypePostForm ContentType = "application/x-www-form-urlencoded"
	ContentTypeFormData ContentType = "multipart/form-data"
	ContentTypeJSON     ContentType = "application/json"
	ContentTypeXML      ContentType = "application/xml"
)

type Driver

type Driver interface {
	Option
	Run(addr ...string) error
}

type HandlerFunc

type HandlerFunc interface{}

type JSON

type JSON interface {
	Marshal(v interface{}) ([]byte, error)
	Unmarshal(data []byte, v interface{}) error
}

func DefaultJSON

func DefaultJSON() JSON

type Mapping

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

func (*Mapping) Method

func (m *Mapping) Method() Method

func (*Mapping) Middleware

func (m *Mapping) Middleware() []HandlerFunc

func (*Mapping) Url

func (m *Mapping) Url() string

type Method

type Method string

const (
	MethodGet     Method = "GET"
	MethodHead    Method = "HEAD"
	MethodPost    Method = "POST"
	MethodPut     Method = "PUT"
	MethodDelete  Method = "DELETE"
	MethodConnect Method = "CONNECT"
	MethodOptions Method = "OPTIONS"
	MethodTrace   Method = "TRACE"
	MethodPatch   Method = "PATCH"
	MethodAny     Method = "ANY"
)

type Option

type Option interface {
	Option(zeta *Zeta)
}

type Serial

type Serial interface {
	Serial(dest interface{}) string
	DeSerial(src interface{}, t reflect.Type) (interface{}, error)
}

func DefaultSerial

func DefaultSerial(jsons ...JSON) Serial

type Validator

type Validator interface {
	Validate(s interface{}) error
}

func DefaultValidator

func DefaultValidator() Validator

type Zeta

type Zeta struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func New

func New(d Driver, options ...Option) *Zeta

func (*Zeta) Complete

func (z *Zeta) Complete()

func (Zeta) Group

func (r Zeta) Group(url string, middleware ...HandlerFunc) *group

func (Zeta) Handle

func (r Zeta) Handle(method Method, url string, middleware ...HandlerFunc) *router

func (Zeta) Mappings

func (r Zeta) Mappings() []Mapping

func (Zeta) Middleware

func (r Zeta) Middleware() []HandlerFunc

func (Zeta) Option

func (r Zeta) Option(z *Zeta)

func (*Zeta) Options

func (z *Zeta) Options(options ...Option) *Zeta

func (*Zeta) Run

func (z *Zeta) Run(addr ...string) error

func (Zeta) Use

func (r Zeta) Use(middleware ...HandlerFunc) *router