openapi

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

const DefinitionsRoot = "#/definitions/"

Variables

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

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