package
0.0.0-20190430154127-a804c55b5eae
Repository: https://github.com/tsaikd/go-raml-parser.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

CheckValueAPIType check value is valid for apiType.
GetLinesInRange return text from (line - distance) to (line + distance).
IsArrayType check name has suffix [].
LoadRAMLFromDir load RAML data from directory, concat *.raml.
NewAPIType return empty APIType.
NewParser create Parser instance.
NewValue cast src to value.
NewValueWithAPIType return Value from src with apiType check.
ParseTargetLocation string to enum.
ParseYAMLError return the error detail info if it's an YAML parse error, yaml parser return error without export error type, so using regexp to check.

# Constants

A declaration of the annotationTypes node, whose key is a name of an annotation type and whose value describes the annotation.
The root of a RAML document.
An item in the collection of items that is the value of the root-level documentation node.
Either an example or examples node.
The root of an extension.
The root of a library.
A method node.
The root of an overlay.
The body node of a method.
A resource (relative URI) node, root-level or nested.
A resource type node.
A declaration of the responses node, whose key is an HTTP status code.
The body node of a response.
A security scheme declaration.
The settings node of a security scheme declaration.
A trait node.
A data type declaration (inline or in a global types collection), header declaration, query parameter declaration, URI parameter declaration, or a property within any of these declarations, where the type property can be used.
RAML built-in types.
RAML built-in types.
RAML built-in types.
RAML built-in types.
RAML built-in types.
RAML built-in types.
RAML built-in types.
RAML built-in types.
RAML built-in types.

# Variables

# Structs

Annotation wrap types defined in spec.
AnnotationType wrap types defined in spec.
APIType wrap types defined in spec.
ArrayType Array types are declared by using either the array qualifier [] at the end of a type expression or array as the value of a type facet.
Body used for Bodies.
Example wrap SingleExample for unmarshal YAML.
FileType The ​file​ type can constrain the content to send through forms.
Header An API's methods can support or require various HTTP headers.
Headers map of Header.
Library wrap LibraryRAML because LibraryRAML may be a string for external library file.
LibraryRAML RAML libraries are used to combine any collection of data type declarations, resource type declarations, trait declarations, and security scheme declarations into modular, externalized, reusable groups.
Method RESTful API methods are operations that are performed on a resource.
ObjectType All types that have the built-in object type at the root of their inheritance tree can use the following facets in their type declarations:.
Properties contain multiple Property.
Property of a object type.
PropertyExtra contain fields no in APIType.
QueryParameter The queryParameters node specifies the set of query parameters from which the query string is composed.
QueryParameters map of QueryParameter.
Resource is identified by its relative URI, which MUST begin with a slash ("/").
Response The value of a response declaration is a map that can contain any of the following key-value pairs:.
RootDocument The root section of the RAML document describes the basic information about an API, such as its title and version.
RootDocumentExtra contain fields no in Library.
ScalarType RAML defines a set of built-in scalar types, each of which has a predefined set of restrictions.
SingleExample The OPTIONAL example facet can be used to attach an example of a type instance to the type declaration.
String A JSON string with the following additional facets:.
Trait wrap TraitRAML because TraitRAML may be a string for using trait.
TraitRAML like a method, can provide method-level nodes such as description, headers, query string parameters, and responses.
TypeDeclaration A type declaration references another type, or wraps or extends another type by adding functional facets (e.g.
Unimplement For extra clarity.
Value multiple types value.

# Interfaces

CheckValueOption for changing CheckValueAPIType behavior.
Parser used to parse raml file.
PostProcessConfig used for PostProcess().
SupportToCheckEmpty implement IsEmpty() instance.

# Type aliases

Annotations map of Annotation.
AnnotationTypes map of AnnotationType.
APITypes map of APIType.
Bodies map of Body.
CheckValueOptionAllowArrayToBeNull allow array type to be null, default: false.
CheckValueOptionAllowIntegerToBeNumber allow type integer to be type number, e.g.
CheckValueOptionAllowRequiredPropertyToBeEmpty allow required property to be empty value, but still should be existed only check the following types: TypeString, TypeArray, TypeObject, TypeBinary default: false.
Examples The OPTIONAL examples facet can be used to attach multiple examples to a type declaration.
HTTPCode For extra clarity.
IsTraits slice of Trait.
Libraries map of Library.
Methods map of Method.
Resources map of Resource.
Responses map of Response.
TargetLocation the location within an API specification where annotations can be applied MUST be one of the target locations in the following Target Locations table.
TargetLocations slice of TargetLocation.
Traits map of Trait.