# Packages
Package apidsl implements the goa design language.
# Functions
CanonicalIdentifier returns the media type identifier sans suffix which is what the DSL uses to store and lookup media types.
Dup creates a copy the given data type.
DupAtt creates a copy of the given attribute.
ExtractWildcards returns the names of the wildcards that appear in path.
HasFile returns true if the underlying type has any file attributes.
HasKnownEncoder returns true if the encoder for the given MIME type is known by goa.
NewAPIDefinition returns a new design with built-in response templates.
NewMediaTypeDefinition creates a media type definition but does not execute the DSL.
NewRandomGenerator returns a random value generator seeded from the given string value.
NewResourceDefinition creates a resource definition but does not execute the DSL.
NewUserTypeDefinition creates a user type definition but does not execute the DSL.
UserTypes traverses the data type recursively and collects all the user types used to define it.
# Constants
List of all built-in response names.
Any is the type for an arbitrary JSON value (interface{} in Go).
AnyKind represents a generic interface{}.
APIKeySecurityKind means "apiKey" security type.
ArrayKind represents a JSON array.
List of all built-in response names.
List of all built-in response names.
BasicAuthSecurityKind means "basic" security type.
Boolean is the type for a JSON boolean.
BooleanKind represents a JSON bool.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
DateTime is the type for a JSON string parsed as a Go time.Time DateTime expects an RFC3339 formatted value.
DateTimeKind represents a JSON string that is parsed as a Go time.Time.
DefaultView is the name of the default view.
List of all built-in response names.
File is the type for a file.
FileKind represents a file.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
HashKind represents a JSON object where the keys are not known in advance.
List of all built-in response names.
Integer is the type for a JSON number without a fraction or exponent part.
IntegerKind represents a JSON integer.
List of all built-in response names.
JWTSecurityKind means an "apiKey" security type, with support for TokenPath and Scopes.
List of all built-in response names.
MediaTypeKind represents a media type.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
NoSecurityKind means to have no security for this endpoint.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
Number is the type for any JSON number, including integers.
NumberKind represents a JSON number including integers.
OAuth2SecurityKind means "oauth2" security type.
ObjectKind represents a JSON object.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
String is the type for a JSON string.
StringKind represents a JSON string.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
List of all built-in response names.
UserTypeKind represents a user type.
UUID is the type for a JSON string parsed as a Go uuid.UUID UUID expects an RFC4122 formatted value.
UUIDKind represents a JSON string that is parsed as a Go uuid.UUID.
# Variables
DefaultDecoders contains the decoding definitions used when no Consumes DSL is found.
DefaultEncoders contains the encoding definitions used when no Produces DSL is found.
Design being built by DSL.
ErrorMedia is the built-in media type for error responses.
ErrorMediaIdentifier is the media type identifier used for error responses.
GeneratedMediaTypes contains DSL definitions that were created by the design DSL and need to be executed as a second pass.
GobContentTypes list the Content-Type header values that cause goa to encode or decode Gob by default.
JSONContentTypes list the Content-Type header values that cause goa to encode or decode JSON by default.
KnownEncoderFunctions contains the list of encoding encoder and decoder functions known by goa indexed by MIME type.
KnownEncoders contains the list of encoding packages and factories known by goa indexed by MIME type.
ProjectedMediaTypes is a cache used by the MediaType strut Project method.
WildcardRegex is the regular expression used to capture path parameters.
XMLContentTypes list the Content-Type header values that cause goa to encode or decode XML by default.
# Structs
No description provided by the author
No description provided by the author
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
No description provided by the author
No description provided by the author
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
RandomGenerator generates consistent random values of different types given a seed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SecurityDefinition defines security requirements for an Action.
SecuritySchemeDefinition defines a security scheme used to authenticate against the API being designed.
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
No description provided by the author
# Interfaces
No description provided by the author
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
# Type aliases
No description provided by the author
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
AttributeIterator is the type of the function given to IterateAttributes.
ByFilePath makes FileServerDefinition sortable for code generators.
No description provided by the author
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
No description provided by the author
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
No description provided by the author
MediaTypeRoot is the data structure that represents the additional DSL definition root that contains the media type definition set created by CollectionOf index by canonical id.
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
It returns the default view - or if not available the link view - or if not available the first view by alphabetical order.
No description provided by the author
No description provided by the author
SecuritySchemeKind is a type of security scheme, according to the swagger specs.
No description provided by the author
ViewIterator is the type of the function given to IterateViews.