Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fully support map and optimization #583

Merged
merged 5 commits into from
Dec 20, 2019
Merged

fully support map and optimization #583

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df2f589
1. parseTypeExpr return poionter to spec.Schema.
sdghchj Dec 13, 2019
81c9212
remove useless comment
sdghchj Dec 13, 2019
0f93d2a
1.fix bug: lost pointer member'description .
sdghchj Dec 14, 2019
ed6cb86
remove GOOS
sdghchj Dec 14, 2019
97187f2
Merge branch 'master' into master
easonlin404 Dec 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 58 additions & 67 deletions parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ func (parser *Parser) ParseDefinition(pkgName, typeName string, typeSpec *ast.Ty
if err != nil {
return err
}
parser.swagger.Definitions[refTypeName] = schema
parser.swagger.Definitions[refTypeName] = *schema
return nil
}

Expand Down Expand Up @@ -648,28 +648,40 @@ func fullTypeName(pkgName, typeName string) string {

// parseTypeExpr parses given type expression that corresponds to the type under
// given name and package, and returns swagger schema for it.
func (parser *Parser) parseTypeExpr(pkgName, typeName string, typeExpr ast.Expr) (spec.Schema, error) {
//TODO: return pointer to spec.Schema
func (parser *Parser) parseTypeExpr(pkgName, typeName string, typeExpr ast.Expr) (*spec.Schema, error) {

switch expr := typeExpr.(type) {
// type Foo struct {...}
case *ast.StructType:
refTypeName := fullTypeName(pkgName, typeName)
if schema, isParsed := parser.swagger.Definitions[refTypeName]; isParsed {
return schema, nil
return &schema, nil
}

return parser.parseStruct(pkgName, expr.Fields)

// type Foo Baz
case *ast.Ident:
if IsGolangPrimitiveType(expr.Name) {
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Type: spec.StringOrArray{TransToValidSchemeType(expr.Name)},
},
}, nil
}
refTypeName := fullTypeName(pkgName, expr.Name)
if _, isParsed := parser.swagger.Definitions[refTypeName]; !isParsed {
if typedef, ok := parser.TypeDefinitions[pkgName][expr.Name]; ok {
parser.ParseDefinition(pkgName, expr.Name, typedef)
}
}
return parser.swagger.Definitions[refTypeName], nil
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Ref: spec.Ref{
Ref: jsonreference.MustCreateRef("#/definitions/" + refTypeName),
},
},
}, nil

// type Foo *Baz
case *ast.StarExpr:
Expand All @@ -679,64 +691,61 @@ func (parser *Parser) parseTypeExpr(pkgName, typeName string, typeExpr ast.Expr)
case *ast.ArrayType:
itemSchema, err := parser.parseTypeExpr(pkgName, "", expr.Elt)
if err != nil {
return spec.Schema{}, err
return &spec.Schema{}, err
}
return spec.Schema{
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &itemSchema,
Schema: itemSchema,
},
},
}, nil

// type Foo pkg.Bar
case *ast.SelectorExpr:
if xIdent, ok := expr.X.(*ast.Ident); ok {
pkgName = xIdent.Name
typeName = expr.Sel.Name
refTypeName := fullTypeName(pkgName, typeName)
if _, isParsed := parser.swagger.Definitions[refTypeName]; !isParsed {
typedef := parser.TypeDefinitions[pkgName][typeName]
parser.ParseDefinition(pkgName, typeName, typedef)
}
return parser.swagger.Definitions[refTypeName], nil
return parser.parseTypeExpr(xIdent.Name, expr.Sel.Name, expr.Sel)
}

// type Foo map[string]Bar
case *ast.MapType:
itemSchema, err := parser.parseTypeExpr(pkgName, "", expr.Value)
if err != nil {
return spec.Schema{}, err
var valueSchema spec.SchemaOrBool
if _, ok := expr.Value.(*ast.InterfaceType); ok {
valueSchema.Allows = true
} else {
schema, err := parser.parseTypeExpr(pkgName, "", expr.Value)
if err != nil {
return &spec.Schema{}, err
}
valueSchema.Schema = schema
}
return spec.Schema{
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Type: []string{"object"},
AdditionalProperties: &spec.SchemaOrBool{
Schema: &itemSchema,
},
Type: []string{"object"},
AdditionalProperties: &valueSchema,
},
}, nil
// ...
default:
Printf("Type definition of type '%T' is not supported yet. Using 'object' instead.\n", typeExpr)
}

return spec.Schema{
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Type: []string{"object"},
},
}, nil
}

func (parser *Parser) parseStruct(pkgName string, fields *ast.FieldList) (spec.Schema, error) {
func (parser *Parser) parseStruct(pkgName string, fields *ast.FieldList) (*spec.Schema, error) {

extraRequired := make([]string, 0)
properties := make(map[string]spec.Schema)
for _, field := range fields.List {
fieldProps, requiredFromAnon, err := parser.parseStructField(pkgName, field)
if err != nil {
return spec.Schema{}, err
return &spec.Schema{}, err
}
extraRequired = append(extraRequired, requiredFromAnon...)
for k, v := range fieldProps {
Expand All @@ -753,7 +762,7 @@ func (parser *Parser) parseStruct(pkgName string, fields *ast.FieldList) (spec.S
properties[k] = prop
}

return spec.Schema{
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Type: []string{"object"},
Properties: properties,
Expand Down Expand Up @@ -812,7 +821,7 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
properties[k] = v
}
case "array":
properties[typeName] = schema
properties[typeName] = *schema
default:
Printf("Can't extract properties from a schema of type '%s'", schemaType)
}
Expand Down Expand Up @@ -957,51 +966,33 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
}
}
} else if astTypeMap, ok := field.Type.(*ast.MapType); ok { // if map
_, err := parser.parseTypeExpr(pkgName, "", astTypeMap.Value)
if err != nil {
return properties, nil, err
}

fullTypeName, err := getFieldType(astTypeMap.Value)
mapValueScheme, err := parser.parseTypeExpr(pkgName, "", astTypeMap)
if err != nil {
return properties, nil, err
}
mapValueScheme := &spec.Schema{
SchemaProps: spec.SchemaProps{
Ref: spec.Ref{
Ref: jsonreference.MustCreateRef("#/definitions/" + fullTypeName),
},
},
}

required := make([]string, 0)
if structField.isRequired {
required = append(required, structField.name)
}
properties[structField.name] = spec.Schema{
SchemaProps: spec.SchemaProps{
Type: []string{structField.schemaType},
Description: desc,
Format: structField.formatType,
Required: required,
Maximum: structField.maximum,
Minimum: structField.minimum,
MaxLength: structField.maxLength,
MinLength: structField.minLength,
Enum: structField.enums,
Default: structField.defaultValue,
AdditionalProperties: &spec.SchemaOrBool{
Schema: mapValueScheme,
},
},
SwaggerSchemaProps: spec.SwaggerSchemaProps{
Example: structField.exampleValue,
ReadOnly: structField.readOnly,
},
VendorExtensible: spec.VendorExtensible{
Extensions: structField.extensions,
},
}
mapValueScheme.Type = []string{structField.schemaType}
mapValueScheme.Description = desc
mapValueScheme.Format = structField.formatType
mapValueScheme.Required = required
mapValueScheme.Maximum = structField.maximum
mapValueScheme.Minimum = structField.minimum
mapValueScheme.MaxLength = structField.maxLength
mapValueScheme.MinLength = structField.minLength
mapValueScheme.Enum = structField.enums
mapValueScheme.Default = structField.defaultValue
mapValueScheme.SwaggerSchemaProps = spec.SwaggerSchemaProps{
Example: structField.exampleValue,
ReadOnly: structField.readOnly,
}
mapValueScheme.VendorExtensible = spec.VendorExtensible{
Extensions: structField.extensions,
}
properties[structField.name] = *mapValueScheme
} else {
required := make([]string, 0)
if structField.isRequired {
Expand Down Expand Up @@ -1036,7 +1027,7 @@ func (parser *Parser) parseStructField(pkgName string, field *ast.Field) (map[st
}

if len(schema.SchemaProps.Type) > 0 {
properties[structField.name] = schema
properties[structField.name] = *schema
return properties, nil, nil
}
}
Expand Down
Loading