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

fix: allow providing a custom request schema #727

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

Merged
merged 1 commit into from
Feb 15, 2025
Merged

fix: allow providing a custom request schema #727

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
15 changes: 8 additions & 7 deletions huma.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,16 +1024,17 @@ func setRequestBodyFromBody(op *Operation, registry Registry, fBody reflect.Stru
if c := fBody.Tag.Get("contentType"); c != "" {
contentType = c
}
hint := getHint(inputType, fBody.Name, op.OperationID+"Request")
if nameHint := fBody.Tag.Get("nameHint"); nameHint != "" {
hint = nameHint
}
s := SchemaFromField(registry, fBody, hint)
if op.RequestBody.Content[contentType] == nil {
op.RequestBody.Content[contentType] = &MediaType{}
}
op.RequestBody.Content[contentType].Schema = s

if op.RequestBody.Content[contentType].Schema == nil {
hint := getHint(inputType, fBody.Name, op.OperationID+"Request")
if nameHint := fBody.Tag.Get("nameHint"); nameHint != "" {
hint = nameHint
}
s := SchemaFromField(registry, fBody, hint)
op.RequestBody.Content[contentType].Schema = s
}
}

type rawBodyType int
Expand Down
40 changes: 34 additions & 6 deletions huma_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,19 +655,13 @@ func TestFeatures(t *testing.T) {
{
Name: "request-body-examples",
Register: func(t *testing.T, api huma.API) {
schema := &huma.Schema{
Type: huma.TypeObject,
Properties: map[string]*huma.Schema{"name": {Type: huma.TypeString}},
}

huma.Register(api, huma.Operation{
Method: http.MethodPut,
Path: "/body",
RequestBody: &huma.RequestBody{
Description: "A description",
Content: map[string]*huma.MediaType{
"application/json": {
Schema: schema,
Examples: map[string]*huma.Example{
"Example 1": {
Summary: "Example summary",
Expand Down Expand Up @@ -889,6 +883,40 @@ func TestFeatures(t *testing.T) {
URL: "/body",
Body: `{"name": "Name"}`,
},
{
Name: "request-body-custom-schema",
Register: func(t *testing.T, api huma.API) {
api.OpenAPI().Components.Schemas.Map()["Dummy"] = &huma.Schema{
Type: huma.TypeObject,
Properties: map[string]*huma.Schema{
"name": {Type: huma.TypeString},
},
}
huma.Register(api, huma.Operation{
Method: http.MethodPut,
Path: "/body",
RequestBody: &huma.RequestBody{
Content: map[string]*huma.MediaType{
"application/json": {
Schema: &huma.Schema{
Ref: "#/components/schemas/Dummy",
},
},
},
},
}, func(ctx context.Context, input *struct {
Body struct {
Name string `json:"name"`
}
}) (*struct{}, error) {
return nil, nil
})
assert.Equal(t, "#/components/schemas/Dummy", api.OpenAPI().Paths["/body"].Put.RequestBody.Content["application/json"].Schema.Ref)
},
Method: http.MethodPut,
URL: "/body",
Body: `{"name": "Name"}`,
},
{
Name: "request-body-embed-struct",
Register: func(t *testing.T, api huma.API) {
Expand Down
Loading