genspec

package

v0.0.0-...-b1d7106 Latest Latest Go to latest Published: Sep 29, 2021 License: MIT Imports: 22 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/uk-taniyama/go-openapi-spec

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CSVMergeLines(src []string) []string
func CSVSplit(line string) ([]string, error)
func Convert(src, dst interface{}) error
func ExpandTagForScheme(scheme *openapi3.Schema, tag KeyValue)
func GenerateOAuth2Scheme(m map[interface{}]interface{}) (string, *openapi3.SecurityScheme, error)
func GenerateSecurityScheme(text string) (string, *openapi3.SecurityScheme, error)
func GenerateSecuritySchemeInterface(i interface{}) (string, *openapi3.SecurityScheme, error)
func GenerateSecuritySchemes(text string) (*openapi3.SecuritySchemes, error)
func MergeMapSlice(a *yaml.MapSlice, b *yaml.MapSlice)
func ParseMapSlice(str string) (*yaml.MapSlice, error)
func StringifyMapSlice(obj *yaml.MapSlice) (string, error)
func TrimSpaceAll(cells []string)
type Config
type Generator
- func NewGenerator(config *Config) (*Generator, error)
- func (g *Generator) Run() error
type KeyValue
- func ParseTag(tag string) KeyValue
- func (kv KeyValue) ConvertFrom(m *map[interface{}]interface{})
- func (kv KeyValue) UnmarshalYAML(unmarshal func(interface{}) error) error
type OpeDoc
- func ParseOpeDoc(doc string) *OpeDoc

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultIdentScheme = map[string]*openapi3.Schema{
	"int":    {Type: "integer"},
	"int32":  {Type: "integer", Format: "int32"},
	"int64":  {Type: "integer", Format: "int64"},
	"string": {Type: "string"},
}

View Source

var PathPattern = regexp.MustCompile("\\(([A-Z]+) (/.+)\\)")

Functions ¶

func CSVMergeLines ¶

func CSVMergeLines(src []string) []string

func CSVSplit ¶

func CSVSplit(line string) ([]string, error)

func Convert ¶

func Convert(src, dst interface{}) error

func ExpandTagForScheme ¶

func ExpandTagForScheme(scheme *openapi3.Schema, tag KeyValue)

func GenerateOAuth2Scheme ¶

func GenerateOAuth2Scheme(m map[interface{}]interface{}) (string, *openapi3.SecurityScheme, error)

func GenerateSecurityScheme ¶

func GenerateSecurityScheme(text string) (string, *openapi3.SecurityScheme, error)

func GenerateSecuritySchemeInterface ¶

func GenerateSecuritySchemeInterface(i interface{}) (string, *openapi3.SecurityScheme, error)

func GenerateSecuritySchemes ¶

func GenerateSecuritySchemes(text string) (*openapi3.SecuritySchemes, error)

func MergeMapSlice ¶

func MergeMapSlice(a *yaml.MapSlice, b *yaml.MapSlice)

func ParseMapSlice ¶

func ParseMapSlice(str string) (*yaml.MapSlice, error)

func StringifyMapSlice ¶

func StringifyMapSlice(obj *yaml.MapSlice) (string, error)

func TrimSpaceAll ¶

func TrimSpaceAll(cells []string)

Types ¶

type Config ¶

type Config struct {
	Debug       bool
	PackageName string // `validate:"required"`
	InputFile   string `validate:"required"`
	OutputFile  string
}

type Generator ¶

type Generator struct {
	// contains filtered or unexported fields
}

func NewGenerator ¶

func NewGenerator(config *Config) (*Generator, error)

func (*Generator) Run ¶

func (g *Generator) Run() error

type KeyValue ¶

type KeyValue map[string]interface{}

func ParseTag ¶

func ParseTag(tag string) KeyValue

func (KeyValue) ConvertFrom ¶

func (kv KeyValue) ConvertFrom(m *map[interface{}]interface{})

func (KeyValue) UnmarshalYAML ¶

func (kv KeyValue) UnmarshalYAML(unmarshal func(interface{}) error) error

type OpeDoc ¶

type OpeDoc struct {
	Desc   string
	Method string
	Path   string
	KV     KeyValue
}

func ParseOpeDoc ¶

func ParseOpeDoc(doc string) *OpeDoc

Source Files ¶

View all Source files

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