operation

Documentation

Index

• func BuildOperations(comments in.SwagifyComment) map[string]OperationBuild
• type Operation
• type OperationBuild

Functions

func BuildOperations

func BuildOperations(comments in.SwagifyComment) map[string]OperationBuild

go-swagify

@@operation: <path url> @@method: get|put|post|delete|options|head|patch|trace @@summary: (optional) @@description: (optional) @@parameters.ref: (optional) semicolon(;) list of ref parameter names @@resp_name: (required) 200, 300, 4xx, etc @@resp_ref: (required) name of the response reference ... @@resp_name, resp_ref can repeat

Types

type Operation

type Operation struct {
	Summary     string             `json:"summary,omitempty" yaml:"summary,omitempty"`
	Description string             `json:"description,omitempty" yaml:"description,omitempty"`
	Tags        []string           `json:"tags,omitempty" yaml:"tags,omitempty"`
	Parameters  []par.ParameterRef `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	RequestBody req.ReqSchema      `json:"requestBody,omitempty" yaml:"requestBody,omitempty"`
	// Servers     []srv.Server    `json:"servers" yaml:"servers"`
	Response map[string]res.Response `json:"responses,omitempty" yaml:"responses,omitempty"`
}

type OperationBuild

type OperationBuild struct {
	Operations map[string]Operation
}

helper struct