route

package

v0.0.0-...-cc73645 Latest Latest Go to latest Published: Apr 22, 2024 License: Apache-2.0 Imports: 0 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/kuuland/kuu

Documentation ¶

Constants ¶

View Source

const (
	String  = "string"
	Integer = "integer"
	Number  = "number"
	Boolean = "boolean"
	Object  = "object"
	Array   = "array"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Param ¶

type Param struct {
	Name        string
	Type        string
	Ref         string
	Required    bool
	Description string
	Default     interface{}
	Format      string `description:"https://json-schema.org/understanding-json-schema/reference/string.html#built-in-formats"`
	Properties  map[string]Param
	Items       []Param
}

func NewArrayParam ¶

func NewArrayParam(name string, description string, required bool, items []Param) Param

func NewBooleanParam ¶

func NewBooleanParam(name string, description string, required bool, defaultValue ...interface{}) Param

func NewExtendedRefArrayParam ¶

func NewExtendedRefArrayParam(name string, description string, required bool, ref string, items []Param) Param

func NewExtendedRefObjectParam ¶

func NewExtendedRefObjectParam(name string, description string, required bool, ref string, properties map[string]Param) Param

func NewIntParam ¶

func NewIntParam(name string, description string, required bool, defaultValue ...interface{}) Param

func NewNumberParam ¶

func NewNumberParam(name string, description string, required bool, defaultValue ...interface{}) Param

func NewObjectParam ¶

func NewObjectParam(name string, description string, required bool, properties map[string]Param) Param

func NewParam ¶

func NewParam(name string, dataType string, description string, required bool, defaultValue ...interface{}) Param

func NewRefArrayParam ¶

func NewRefArrayParam(name string, description string, required bool, ref string) Param

func NewRefObjectParam ¶

func NewRefObjectParam(name string, description string, required bool, ref string) Param

func NewStringParam ¶

func NewStringParam(name string, description string, required bool, defaultValue ...interface{}) Param

type RequestParams ¶

type RequestParams struct {
	Query    []Param
	Body     []Param
	FormData []Param
	Headers  []Param
	Path     []Param
}

type ResponseParams ¶

type ResponseParams struct {
	STDResponse bool
	Success     []Param
	Failure     map[int]string
}

Source Files ¶

View all Source files

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