Documentation
¶
Overview ¶
Package openapi3gen generates OpenAPI 3 schemas for Go types.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var RefSchemaRef = openapi3.NewSchemaRef("Ref", openapi3.NewObjectSchema().WithProperty("$ref", openapi3.NewStringSchema().WithMinLength(1)))
Functions ¶
Types ¶
type CycleError ¶
type CycleError struct{}
CycleError indicates that a type graph has one or more possible cycles.
func (*CycleError) Error ¶
func (err *CycleError) Error() string
type Generator ¶
type Generator struct {
Types map[reflect.Type]*openapi3.SchemaRef
// SchemaRefs contains all references and their counts.
// If count is 1, it's not ne
// An OpenAPI identifier has been assigned to each.
SchemaRefs map[*openapi3.SchemaRef]int
}
func NewGenerator ¶
func NewGenerator() *Generator
Source Files
Click to show internal directories.
Click to hide internal directories.