Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

parameter

package

Go to main page

Versions in this module

v1

v1.2.5

Dec 11, 2024

v1.2.4

Dec 11, 2024

v1.2.3

Dec 10, 2024

v1.2.2

Oct 10, 2024

v1.2.1

Oct 8, 2024

v1.2.0

Apr 25, 2024

v1.1.0

Apr 24, 2024

v1.0.0

Dec 19, 2023

Changes in this version

+ var NoParam []Parameter

+ type CollectionFormat string

+ const CSV

+ const Multi

+ const Pipes

+ const SSV

+ const TSV

+ func (c CollectionFormat) String() string

+ type JsonParameter struct

+ CollenctionFormat string

+ Default interface{}

+ Description string

+ Enum []interface{}

+ Format string

+ In string

+ Max int64

+ MaxItems int64

+ MaxLen int64

+ Min int64

+ MinItems int64

+ MinLen int64

+ MultipleOf int64

+ Name string

+ Pattern string

+ Required bool

+ Schema *JsonResponseSchema

+ Type string

+ UniqueItems bool

+ type JsonResponseSchema struct

+ Items *JsonResponseSchemeItems

+ Ref string

+ Type string

+ type JsonResponseSchemeItems struct

+ Items *JsonResponseSchemeItems

+ Ref string

+ Type string

+ type Location string

+ const Form

+ const Header

+ const Path

+ const Query

+ func (l Location) String() string

+ type Option func(*Parameter)

+ func WithCollectionFormat(c CollectionFormat) Option

+ func WithDefault(defaultValue interface{}) Option

+ func WithDescription(description string) Option

+ func WithFormat(format string) Option

+ func WithIn(in Location) Option

+ func WithMax(max int64) Option

+ func WithMaxItems(maxItems int64) Option

+ func WithMaxLen(maxLen int64) Option

+ func WithMin(min int64) Option

+ func WithMinItems(minItems int64) Option

+ func WithMinLen(minLen int64) Option

+ func WithMultipleOf(multipleOf int64) Option

+ func WithPattern(pattern string) Option

+ func WithRequired() Option

+ func WithType(t ParamType) Option

+ func WithUniqueItems(uniqueItems bool) Option

+ type ParamType string

+ const Array

+ const Boolean

+ const File

+ const Integer

+ const Number

+ const String

+ func (p ParamType) String() string

+ type Parameter struct

+ func BoolParam(name string, l Location, opts ...Option) *Parameter

+ func FileParam(name string, opts ...Option) *Parameter

+ func IntArrParam(name string, l Location, arr []int64, opts ...Option) *Parameter

+ func IntEnumParam(name string, l Location, arr []int64, opts ...Option) *Parameter

+ func IntParam(name string, l Location, opts ...Option) *Parameter

+ func Params(params ...Parameter) (paramsArr []Parameter)

+ func StrArrParam(name string, l Location, arr []string, opts ...Option) *Parameter

+ func StrEnumParam(name string, l Location, arr []string, opts ...Option) *Parameter

+ func StrParam(name string, l Location, opts ...Option) *Parameter

+ func (p *Parameter) AsJson() JsonParameter

+ func (p Parameter) Location() Location