openapi

package

v0.0.0-...-9345cf7 Latest Latest Go to latest Published: May 6, 2024 License: Apache-2.0 Imports: 5 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/kubegems/library

Links

Open Source Insights

README ¶

OpenAPI

Documentation ¶

Index ¶

Constants
Variables
func IntFmtProperty(format string) *spec.Schema
func IsDynamicInterface(t reflect.Type) bool
func ObjectProperty() *spec.Schema
func ObjectPropertyProperties(properties spec.SchemaProperties) *spec.Schema
func TypeName(t reflect.Type) string
type Builder
- func NewBuilder(interfaceOption InterfaceBuildOption, definations map[string]spec.Schema) *Builder
- func (b *Builder) Build(data any) *spec.Schema
- func (b *Builder) BuildSchema(v reflect.Value) *spec.Schema
type InterfaceBuildOption
type SchemaBuildFunc

Constants ¶

View Source

const DefinitionsRoot = "#/definitions/"

Variables ¶

View Source

var (
	DefaultDefinitions = map[string]spec.Schema{}
	DefaultBuilder     = NewBuilder(InterfaceBuildOptionOverride, DefaultDefinitions)
)

View Source

var WellKnowGoTypeAsSchema = map[reflect.Type]spec.Schema{
	reflect.TypeOf(json.Number("")): *spec.Float64Property(),

	reflect.TypeOf(time.Time{}):      *spec.DateTimeProperty(),
	reflect.TypeOf(time.Duration(0)): *spec.StrFmtProperty("duration"),
}

Functions ¶

func IntFmtProperty ¶

func IntFmtProperty(format string) *spec.Schema

StrFmtProperty creates a property for the named string format

func IsDynamicInterface ¶

func IsDynamicInterface(t reflect.Type) bool

func ObjectProperty ¶

func ObjectProperty() *spec.Schema

func ObjectPropertyProperties ¶

func ObjectPropertyProperties(properties spec.SchemaProperties) *spec.Schema

func TypeName ¶

func TypeName(t reflect.Type) string

Types ¶

type Builder ¶

type Builder struct {
	InterfaceBuildOption InterfaceBuildOption
	Definitions          map[string]spec.Schema
}

func NewBuilder ¶

func NewBuilder(interfaceOption InterfaceBuildOption, definations map[string]spec.Schema) *Builder

func (*Builder) Build ¶

func (b *Builder) Build(data any) *spec.Schema

func (*Builder) BuildSchema ¶

func (b *Builder) BuildSchema(v reflect.Value) *spec.Schema

type InterfaceBuildOption ¶

type InterfaceBuildOption string

const (
	InterfaceBuildOptionDefault  InterfaceBuildOption = ""         // default as an 'object{}'
	InterfaceBuildOptionOverride InterfaceBuildOption = "override" // override using interface's value if exist
	InterfaceBuildOptionIgnore   InterfaceBuildOption = "ignore"   // ignore interface field
	InterfaceBuildOptionMerge    InterfaceBuildOption = "merge"    // anyOf 'object{}' type and interface's value type
)

type SchemaBuildFunc ¶

type SchemaBuildFunc func(v reflect.Value) *spec.Schema

Source Files ¶

View all Source files

builder.go

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