restful

package

v2.0.0-...-a27a8c5 Latest Latest Go to latest Published: Sep 2, 2021 License: Apache-2.0 Imports: 11 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

View Source

const KeyOpenAPITags = restfulSpec.KeyOpenAPITags

KeyOpenAPITags is a Metadata key for a restful Route

View Source

const MediaTypeApplicationJson = "application/json"

This section is empty.

func Add(ws *WebService)

func RegisterModel(m Model)

func RegisterModelName(name string, m interface{})

func RegisterModels(registerModelFun func())

func RegisteredModel(dtoName string) (interface{}, bool)

func StartService()

type Context struct {
	Request  *emkRestful.Request
	Response *emkRestful.Response
}

Context context request and response

type Model interface {
	ModelName() string
}

type Route struct {
	*emkRestful.Route
}

type RouteBuilder struct {
	*emkRestful.RouteBuilder
	// contains filtered or unexported fields
}

func (b *RouteBuilder) To(function RouteFunction) *RouteBuilder

If this route is matched with the incoming Http Request then call this function with the *Context. Required.

type RouteFunction func(ctx *Context)

type WebService struct {
	emkRestful.WebService
	// contains filtered or unexported fields
}

Webservice web service

func NewWebService(name string) *WebService

func (ws *WebService) AddDocs()

func (ws *WebService) GET(subPath string) *RouteBuilder

GET is a shortcut for .Method("GET").Path(subPath)

func (ws *WebService) Name() string

func (ws *WebService) Route(builder *RouteBuilder) *WebService