Documentation ¶
Index ¶
- Constants
- Variables
- type CommentRegistry
- type MetadataParser
- type SpecField
- type SpecType
- type StructMetadata
- type TargetField
- func (t *TargetField) AdditionalProperties() *SpecField
- func (t *TargetField) CanonicalFieldName(structTag string) string
- func (t *TargetField) Elem() types.Type
- func (t *TargetField) HasAdditionalProperties() bool
- func (t *TargetField) ID() string
- func (t *TargetField) IsAdditionalProperties() bool
- func (t *TargetField) IsArrayType() bool
- func (t *TargetField) SetAdditionalProperties(additionalProperties *SpecField)
- func (t *TargetField) SetElem(elem types.Type)
- func (t *TargetField) SetIsAdditionalProperties()
- func (t *TargetField) SetIsArrayType()
- func (t *TargetField) SetSpecField(specField *SpecField)
- func (t *TargetField) SpecField() *SpecField
- func (t *TargetField) UnderlyingElem() types.Type
- type TargetStruct
- type TargetType
Constants ¶
View Source
const ( DescriptionAttr = "@description" TitleAttr = "@title" )
Variables ¶
View Source
var StructFieldTypeMap = map[string]*SpecField{ "string": NewSpecField(StringType), "int": NewSpecField(IntegerType), "float32": NewSpecField(NumberType), "float64": NewSpecField(NumberType), "bool": NewSpecField(BooleanType), "time.Time": NewSpecFieldWithFormat(StringType, TimeFormat), }
Functions ¶
This section is empty.
Types ¶
type CommentRegistry ¶
type CommentRegistry struct {
// contains filtered or unexported fields
}
func NewCommentRegistry ¶
func NewCommentRegistry() *CommentRegistry
func (*CommentRegistry) Load ¶
func (c *CommentRegistry) Load(pkgs ...*packages.Package)
Load loads struct as well as struct field comments and builds comment registry for given packages.
func (*CommentRegistry) Lookup ¶
func (c *CommentRegistry) Lookup(key string) string
type MetadataParser ¶
type MetadataParser struct { }
func NewMetadataParser ¶
func NewMetadataParser() *MetadataParser
func (*MetadataParser) ParseStructDesc ¶
func (o *MetadataParser) ParseStructDesc(desc string) StructMetadata
type SpecField ¶
type SpecField struct {
// contains filtered or unexported fields
}
func NewArraySpecField ¶
func NewSpecField ¶
func NewSpecFieldWithFormat ¶
func NewStructSpecField ¶
func (*SpecField) SetItemsType ¶
func (*SpecField) ToSchemaProp ¶
func (s *SpecField) ToSchemaProp(description string) spec.SchemaProps
type StructMetadata ¶
type TargetField ¶
type TargetField struct {
// contains filtered or unexported fields
}
func NewTargetField ¶
func NewTargetField(packageID string, structName string, fieldTag string, fieldName string) *TargetField
func (*TargetField) AdditionalProperties ¶
func (t *TargetField) AdditionalProperties() *SpecField
func (*TargetField) CanonicalFieldName ¶
func (t *TargetField) CanonicalFieldName(structTag string) string
func (*TargetField) Elem ¶
func (t *TargetField) Elem() types.Type
func (*TargetField) HasAdditionalProperties ¶
func (t *TargetField) HasAdditionalProperties() bool
func (*TargetField) ID ¶
func (t *TargetField) ID() string
func (*TargetField) IsAdditionalProperties ¶
func (t *TargetField) IsAdditionalProperties() bool
func (*TargetField) IsArrayType ¶
func (t *TargetField) IsArrayType() bool
func (*TargetField) SetAdditionalProperties ¶
func (t *TargetField) SetAdditionalProperties(additionalProperties *SpecField)
func (*TargetField) SetElem ¶
func (t *TargetField) SetElem(elem types.Type)
func (*TargetField) SetIsAdditionalProperties ¶
func (t *TargetField) SetIsAdditionalProperties()
func (*TargetField) SetIsArrayType ¶
func (t *TargetField) SetIsArrayType()
func (*TargetField) SetSpecField ¶
func (t *TargetField) SetSpecField(specField *SpecField)
func (*TargetField) SpecField ¶
func (t *TargetField) SpecField() *SpecField
func (*TargetField) UnderlyingElem ¶
func (t *TargetField) UnderlyingElem() types.Type
type TargetStruct ¶
type TargetStruct struct {
// contains filtered or unexported fields
}
func NewTargetStruct ¶
func (*TargetStruct) ID ¶
func (t *TargetStruct) ID() string
func (*TargetStruct) IsNamedType ¶
func (t *TargetStruct) IsNamedType() bool
func (*TargetStruct) Name ¶
func (t *TargetStruct) Name() string
func (*TargetStruct) OriginalStruct ¶
func (t *TargetStruct) OriginalStruct() *types.Struct
func (*TargetStruct) OriginalType ¶
func (t *TargetStruct) OriginalType() types.Type
func (*TargetStruct) ToNamedType ¶
func (t *TargetStruct) ToNamedType() *types.Named
type TargetType ¶
type TargetType struct {
// contains filtered or unexported fields
}
TargetType represents
func NewTargetType ¶
func NewTargetType(name string, origObj types.Object) *TargetType
func (*TargetType) IsNamedType ¶
func (t *TargetType) IsNamedType() bool
func (*TargetType) IsStruct ¶
func (t *TargetType) IsStruct() bool
func (*TargetType) IsValid ¶
func (t *TargetType) IsValid() bool
func (*TargetType) ToNamedType ¶
func (t *TargetType) ToNamedType() *types.Named
func (*TargetType) ToTargetStruct ¶
func (t *TargetType) ToTargetStruct() *TargetStruct
Source Files ¶
Click to show internal directories.
Click to hide internal directories.