swagger

Documentation

Index

• Variables
• func BytesFromFile(path string) []byte
• func GenMod(cfg, generatePath string) (*generate.Model, error)
• func GenServer(cfg, generatePath string) (*generate.Server, error)
• func GetHandlerOutputName(operID, restMethod string) string
• func GoFiles(pathPart string) []string
• func OperationCheck(oper *spec.Operation) bool
• func OperationsPath(part string) string
• func ParseOperations(pathItem spec.PathItem, operationalPath string) *models.Operation
• func RemoveDupes(sliceToCheck []string) []string
• func SpecParser(path string) (*spec.Swagger, error)
• type GenerationType
  • func ParseGenType(s string) GenerationType
  • func (s GenerationType) String() string
• type IDummy
  • func NewDummy() IDummy
• type ISwagger
  • func NewSwagger(cfg *config_swagger.SwaggerCfg) ISwagger

Variables

var ErrClientNotImplemented = errors.New("client option is not implemented yet")

var ErrGenTypeUndefined = errors.New("generation type is undefined. Must be: server/models/client`")

var ErrNilCfgModelsOpts = errors.New(" value: `Models` in your config_swagger is nil")

var ErrNilCfgServerOpts = errors.New(" value: `Server` in your config_swagger is nil")

var ErrNilGenerationPathOrOutput = errors.New("spec file path AND/OR generation output path are nil")

Functions

func BytesFromFile

func BytesFromFile(path string) []byte

func GenMod

func GenMod(cfg, generatePath string) (*generate.Model, error)

func GenServer

func GenServer(cfg, generatePath string) (*generate.Server, error)

func GetHandlerOutputName

func GetHandlerOutputName(operID, restMethod string) string

func GoFiles

func GoFiles(pathPart string) []string

func OperationCheck

func OperationCheck(oper *spec.Operation) bool

func OperationsPath

func OperationsPath(part string) string

func ParseOperations

func ParseOperations(pathItem spec.PathItem, operationalPath string) *models.Operation

func RemoveDupes

func RemoveDupes(sliceToCheck []string) []string

func SpecParser

func SpecParser(path string) (*spec.Swagger, error)

Types

type GenerationType

type GenerationType int

const (
	ServerGen GenerationType = iota
	ModelsGen
	ClientGen // TODO

)

func ParseGenType

func ParseGenType(s string) GenerationType

func (GenerationType) String

func (s GenerationType) String() string

type IDummy

type IDummy interface {
	GetHandlersModel() *models.Handlers
	Call(cfg string) error
}

func NewDummy

func NewDummy() IDummy

type ISwagger

type ISwagger interface {
	Generate(genType string) error
}

func NewSwagger

func NewSwagger(cfg *config_swagger.SwaggerCfg) ISwagger