annotation

package

v0.4.5 Latest Latest Go to latest Published: Mar 6, 2023 License: MIT Imports: 9 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/RussellLuo/kun

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GetDescriptionFromDoc(doc []string) string
func ParseMetadata(doc []string) (*spec.Metadata, error)
func ParseParamOptions(argName, s string) ([]*spec.Parameter, error)
func ParseSuccess(s string, method *ifacetool.Method) (*spec.Response, error)
type Aliases
- func ParseAliases(doc []string) (Aliases, error)
- func (a Aliases) Eval(value string) (string, error)
- func (a Aliases) Set(key, value string)
type Body
- func ParseBody(s string) (*Body, error)
type InterfaceAnnotation
- func ParseInterfaceAnnotation(doc []string) (*InterfaceAnnotation, error)
type Manipulation
type MethodAnnotation
- func ParseMethodAnnotation(method *ifacetool.Method, aliases Aliases) (*MethodAnnotation, error)
type Op
- func ParseOp(s string) (*Op, error)
type Param
- func ParseParams(s string) ([]*Param, error)

Constants ¶

View Source

const (
	OptionNoBody = "-"
)

Variables ¶

This section is empty.

Functions ¶

func GetDescriptionFromDoc ¶

func GetDescriptionFromDoc(doc []string) string

func ParseMetadata ¶

func ParseMetadata(doc []string) (*spec.Metadata, error)

ParseMetadata parses doc per the format as below:

<property>=<value>

func ParseParamOptions ¶

func ParseParamOptions(argName, s string) ([]*spec.Parameter, error)

func ParseSuccess ¶

func ParseSuccess(s string, method *ifacetool.Method) (*spec.Response, error)

ParseSuccess parses s per the format as below:

statusCode=<statusCode> body=<body> manip=`<manipulation> [; <manipulation2> [; ...]]`

The format of `<manipulation>`:

<argName> name=<name> type=<type> descr=<descr>

Types ¶

type Aliases ¶

type Aliases map[string]string

func ParseAliases ¶

func ParseAliases(doc []string) (Aliases, error)

ParseAliases parses doc per the format as below:

<name>=`<value>`

func (Aliases) Eval ¶

func (a Aliases) Eval(value string) (string, error)

Eval replaces all possible aliases with their values.

func (Aliases) Set ¶

func (a Aliases) Set(key, value string)

type Body ¶

type Body struct {
	Field         string
	Manipulations map[string]*Manipulation
}

func ParseBody ¶

func ParseBody(s string) (*Body, error)

ParseBody parses s per the format as below:

<field> or <manipulation> [; <manipulation2> [; ...]]

The format of `<manipulation>`:

<argName> name=<name> type=<type> descr=<descr>

type InterfaceAnnotation ¶

type InterfaceAnnotation struct {
	Metadata *spec.Metadata
	Aliases  Aliases
}

func ParseInterfaceAnnotation ¶

func ParseInterfaceAnnotation(doc []string) (*InterfaceAnnotation, error)

type Manipulation ¶

type Manipulation struct {
	Name        string
	Type        string
	Description string
}

type MethodAnnotation ¶

type MethodAnnotation struct {
	Ops     []*Op
	Params  map[string]*Param
	Body    *Body
	Success *spec.Response
	Tags    []string
}

func ParseMethodAnnotation ¶

func ParseMethodAnnotation(method *ifacetool.Method, aliases Aliases) (*MethodAnnotation, error)

type Op ¶

type Op struct {
	Method  string
	Pattern string
}

func ParseOp ¶

func ParseOp(s string) (*Op, error)

ParseOp parses s per the format as below:

<method> <pattern>

type Param ¶

type Param struct {
	ArgName string
	Params  []*spec.Parameter
}

func ParseParams ¶

func ParseParams(s string) ([]*Param, error)

ParseParams parses s per the format as below:

<argName> [<parameter> [, <parameter2> [, ...]]]

The format of `<parameter>`:

in=<in> name=<name> required=<required> type=<type> descr=<descr>

Multiple bindings can be specified in a single semicolon-separated comment.

Source Files ¶

View all Source files

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