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

apidsl

package

Go to main page

Versions in this module

v1

v1.3.1

Jan 4, 2018

v1.3.0

Aug 25, 2017

v1.2.1

Aug 24, 2017

v1.2.0

Apr 17, 2017

v1.1.0

Dec 14, 2016

v1.0.0

Aug 2, 2016

Changes in this version

+ var SupportedValidationFormats = []string

+ func API(name string, dsl func()) *design.APIDefinition

+ func APIKeySecurity(name string, dsl ...func()) *design.SecuritySchemeDefinition

+ func AccessCodeFlow(authorizationURL, tokenURL string)

+ func Action(name string, dsl func())

+ func ApplicationFlow(tokenURL string)

+ func ArrayOf(t design.DataType) *design.Array

+ func Attribute(name string, args ...interface{})

+ func Attributes(apidsl func())

+ func BasePath(val string)

+ func BasicAuthSecurity(name string, dsl ...func()) *design.SecuritySchemeDefinition

+ func CONNECT(path string) *design.RouteDefinition

+ func CanonicalActionName(a string)

+ func CollectionOf(v interface{}, apidsl ...func()) *design.MediaTypeDefinition

+ func Consumes(args ...interface{})

+ func Contact(dsl func())

+ func ContentType(typ string)

+ func Credentials()

+ func DELETE(path string) *design.RouteDefinition

+ func Default(def interface{})

+ func DefaultMedia(val interface{}, viewName ...string)

+ func Description(d string)

+ func Docs(dsl func())

+ func Email(email string)

+ func Enum(val ...interface{})

+ func Example(exp interface{})

+ func Expose(vals ...string)

+ func Files(path, filename string, dsls ...func())

+ func Format(f string)

+ func Function(fn string)

+ func GET(path string) *design.RouteDefinition

+ func HEAD(path string) *design.RouteDefinition

+ func HashOf(k, v design.DataType) *design.Hash

+ func Header(name string, args ...interface{})

+ func Headers(params ...interface{})

+ func Host(host string)

+ func ImplicitFlow(authorizationURL string)

+ func JWTSecurity(name string, dsl ...func()) *design.SecuritySchemeDefinition

+ func License(dsl func())

+ func Link(name string, view ...string)

+ func Links(apidsl func())

+ func MaxAge(val uint)

+ func MaxLength(val int)

+ func Maximum(val interface{})

+ func Media(val interface{}, viewName ...string)

+ func MediaType(identifier string, apidsl func()) *design.MediaTypeDefinition

+ func Member(name string, args ...interface{})

+ func Metadata(name string, value ...string)

+ func Methods(vals ...string)

+ func MinLength(val int)

+ func Minimum(val interface{})

+ func Name(name string)

+ func NoExample()

+ func NoSecurity()

+ func OAuth2Security(name string, dsl ...func()) *design.SecuritySchemeDefinition

+ func OPTIONS(path string) *design.RouteDefinition

+ func OptionalPayload(p interface{}, dsls ...func())

+ func Origin(origin string, dsl func())

+ func PATCH(path string) *design.RouteDefinition

+ func POST(path string) *design.RouteDefinition

+ func PUT(path string) *design.RouteDefinition

+ func Package(path string)

+ func Param(name string, args ...interface{})

+ func Params(dsl func())

+ func Parent(p string)

+ func PasswordFlow(tokenURL string)

+ func Pattern(p string)

+ func Payload(p interface{}, dsls ...func())

+ func Produces(args ...interface{})

+ func Query(parameterName string)

+ func Reference(t design.DataType)

+ func Required(names ...string)

+ func Resource(name string, dsl func()) *design.ResourceDefinition

+ func Response(name string, paramsAndDSL ...interface{})

+ func ResponseTemplate(name string, p interface{})

+ func Routing(routes ...*design.RouteDefinition)

+ func Scheme(vals ...string)

+ func Scope(name string, desc ...string)

+ func Security(scheme interface{}, dsl ...func())

+ func Status(status int)

+ func TRACE(path string) *design.RouteDefinition

+ func TermsOfService(terms string)

+ func Title(val string)

+ func TokenURL(tokenURL string)

+ func Trait(name string, val ...func())

+ func Type(name string, dsl func()) *design.UserTypeDefinition

+ func TypeName(name string)

+ func URL(url string)

+ func UseTrait(name string)

+ func Version(ver string)

+ func View(name string, apidsl ...func())