swagger

package

v0.0.6 Latest Latest Go to latest Published: Sep 22, 2023 License: MIT Imports: 14 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

This section is empty.

View Source

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

View Source

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

View Source

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

View Source

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

View Source

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

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 int

const (
	ServerGen GenerationType = iota
	ModelsGen
	ClientGen // TODO

)

func ParseGenType(s string) GenerationType

func (s GenerationType) String() string

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

func NewDummy() IDummy

type ISwagger interface {
	Generate(genType string) error
}

func NewSwagger(cfg *config_swagger.SwaggerCfg) ISwagger