这是indexloc提供的服务，不要输入任何密码
Skip to content

#560: Add reusing of primitive-based types in the generated OAS. #758

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

#560: Add reusing of primitive-based types in the generated OAS. #758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 35 additions & 12 deletions registry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,23 @@ func DefaultSchemaNamer(t reflect.Type, hint string) string {
return name
}

type mapRegistryOption func(*mapRegistry)

// WithPrimitiveTypeReuse allows primitive types to be reused.
func WithPrimitiveTypeReuse() mapRegistryOption {
return func(r *mapRegistry) {
r.reusePrimitive = true
}
}

type mapRegistry struct {
prefix string
schemas map[string]*Schema
types map[string]reflect.Type
seen map[reflect.Type]bool
namer func(reflect.Type, string) string
aliases map[reflect.Type]reflect.Type
prefix string
schemas map[string]*Schema
types map[string]reflect.Type
seen map[reflect.Type]bool
namer func(reflect.Type, string) string
aliases map[reflect.Type]reflect.Type
reusePrimitive bool
}

func (r *mapRegistry) Schema(t reflect.Type, allowRef bool, hint string) *Schema {
Expand All @@ -83,6 +93,13 @@ func (r *mapRegistry) Schema(t reflect.Type, allowRef bool, hint string) *Schema
}

getsRef := t.Kind() == reflect.Struct

isNamedPrimitive := t.PkgPath() != "" && t.Name() != "" && t.Kind() != reflect.Struct
if isNamedPrimitive && r.reusePrimitive {
// Special case: named primitive-based types are reused.
getsRef = true
}

if t == timeType {
// Special case: time.Time is always a string.
getsRef = false
Expand Down Expand Up @@ -162,13 +179,19 @@ func (r *mapRegistry) RegisterTypeAlias(t reflect.Type, alias reflect.Type) {

// NewMapRegistry creates a new registry that stores schemas in a map and
// returns references to them using the given prefix.
func NewMapRegistry(prefix string, namer func(t reflect.Type, hint string) string) Registry {
return &mapRegistry{
func NewMapRegistry(prefix string, namer func(t reflect.Type, hint string) string, opts ...mapRegistryOption) Registry {
r := mapRegistry{
prefix: prefix,
schemas: map[string]*Schema{},
types: map[string]reflect.Type{},
seen: map[reflect.Type]bool{},
aliases: map[reflect.Type]reflect.Type{},
schemas: make(map[string]*Schema),
types: make(map[string]reflect.Type),
seen: make(map[reflect.Type]bool),
namer: namer,
aliases: make(map[reflect.Type]reflect.Type),
}

for _, opt := range opts {
opt(&r)
}

return &r
}
45 changes: 45 additions & 0 deletions registry_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,48 @@ func TestSchemaAlias(t *testing.T) {
schemaWithString := registry.Schema(reflect.TypeOf(StructWithString{}), false, "")
assert.Equal(t, schemaWithString, schemaWithContainer)
}

func TestReusePrimitiveType(t *testing.T) {
type (
CustomHeader string

firstRequest struct {
Header CustomHeader `json:"header" description:"A custom header"`
}

secondRequest struct {
AnotherHeader CustomHeader `json:"another_header" description:"Another custom header"`
}
)

// Default settings
registry := NewMapRegistry("#/components/schemas", DefaultSchemaNamer)

first := SchemaFromType(registry, reflect.TypeOf(firstRequest{}))
second := SchemaFromType(registry, reflect.TypeOf(secondRequest{}))

if first.Properties["header"].Ref != "" {
t.Errorf("Expected header to be defined inline, but got a ref: %s", first.Properties["header"].Ref)
}
if second.Properties["another_header"].Ref != "" {
t.Errorf("Expected another_header to be defined inline, but got a ref: %s", second.Properties["another_header"].Ref)
}

// Reusing primitive types enabled
registry = NewMapRegistry("#/components/schemas", DefaultSchemaNamer, WithPrimitiveTypeReuse())

first = SchemaFromType(registry, reflect.TypeOf(firstRequest{}))
second = SchemaFromType(registry, reflect.TypeOf(secondRequest{}))

if first.Properties["header"].Ref == "" {
t.Errorf("Expected header to use a ref, but it's defined inline")
}
if second.Properties["another_header"].Ref == "" {
t.Errorf("Expected another_header to use a ref, but it's defined inline")
}

if first.Properties["header"].Ref != second.Properties["another_header"].Ref {
t.Errorf("Expected both properties to use the same ref, but got %s and %s",
first.Properties["header"].Ref, second.Properties["another_header"].Ref)
}
}
Loading