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

feat: add example for oneOf response, fix custom schema usage #147

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
Oct 20, 2023
Merged

feat: add example for oneOf response, fix custom schema usage #147

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
101 changes: 101 additions & 0 deletions examples/oneof-response/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
// This example show how to respond to API requests with different versions of
// the response body. Try the following requests:
//
// # Get the latest version of the response
// restish get :8888/greeting/oneof
//
// # Get the old version of the response
// restish get :8888/greeting/oneof -H X-Old-Version:true
package main

import (
"context"
"fmt"
"net/http"
"reflect"

"github.com/danielgtaylor/huma/v2"
"github.com/danielgtaylor/huma/v2/adapters/humachi"
"github.com/go-chi/chi/v5"
)

// Options for the CLI.
type Options struct {
Port int `help:"Port to listen on" default:"8888"`
}

// GreetingInput represents the greeting operation request.
type GreetingInput struct {
Name string `path:"name" doc:"Name to greet"`
OldVersion bool `header:"X-Old-Version" doc:"Use the old version of the API response"`
}

// GreetingOutput represents the greeting operation response.
type GreetingOutput struct {
Body any
}

// GreetingBody is the body of the response for the latest version of the API.
type GreetingBody struct {
Message string `json:"message"`
}

// GreetingBodyOld is the body of the response for the old version of the API.
type GreetingBodyOld struct {
Msg string `json:"msg"`
}

func main() {
// Create a CLI app which takes a port option.
cli := huma.NewCLI(func(hooks huma.Hooks, options *Options) {
// Create a new router & API
router := chi.NewMux()
api := humachi.New(router, huma.DefaultConfig("My API", "1.0.0"))

// Create a schema for the output body.
registry := api.OpenAPI().Components.Schemas
schema := &huma.Schema{
OneOf: []*huma.Schema{
registry.Schema(reflect.TypeOf(GreetingBody{}), true, ""),
registry.Schema(reflect.TypeOf(GreetingBodyOld{}), true, ""),
},
}

// Register GET /greeting/{name}
huma.Register(api, huma.Operation{
OperationID: "get-greeting",
Summary: "Get a greeting",
Method: http.MethodGet,
Path: "/greeting/{name}",
Responses: map[string]*huma.Response{
"200": {
Content: map[string]*huma.MediaType{
"application/json": {
Schema: schema,
},
},
},
},
}, func(ctx context.Context, input *GreetingInput) (*GreetingOutput, error) {
resp := &GreetingOutput{}
msg := fmt.Sprintf("Hello, %s!", input.Name)

// Set the output body based on what the user has requested.
if input.OldVersion {
resp.Body = GreetingBodyOld{Msg: msg}
} else {
resp.Body = GreetingBody{Message: msg}
}

return resp, nil
})

// Tell the CLI how to start your router.
hooks.OnStart(func() {
http.ListenAndServe(fmt.Sprintf(":%d", options.Port), router)
})
})

// Run the CLI. When passed no commands, it starts the server.
cli.Run()
}
18 changes: 11 additions & 7 deletions huma.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,13 +373,15 @@ func Register[I, O any](api API, op Operation, handler func(context.Context, *I)
inputBodyIndex := -1
if f, ok := inputType.FieldByName("Body"); ok {
inputBodyIndex = f.Index[0]
op.RequestBody = &RequestBody{
Required: f.Type.Kind() != reflect.Ptr && f.Type.Kind() != reflect.Interface,
Content: map[string]*MediaType{
"application/json": {
Schema: registry.Schema(f.Type, true, getHint(inputType, f.Name, op.OperationID+"Request")),
if op.RequestBody == nil {
op.RequestBody = &RequestBody{
Required: f.Type.Kind() != reflect.Ptr && f.Type.Kind() != reflect.Interface,
Content: map[string]*MediaType{
"application/json": {
Schema: registry.Schema(f.Type, true, getHint(inputType, f.Name, op.OperationID+"Request")),
},
},
},
}
}

if op.BodyReadTimeout == 0 {
Expand Down Expand Up @@ -457,7 +459,9 @@ func Register[I, O any](api API, op Operation, handler func(context.Context, *I)
if _, ok := op.Responses[statusStr].Content["application/json"]; !ok {
op.Responses[statusStr].Content["application/json"] = &MediaType{}
}
op.Responses[statusStr].Content["application/json"].Schema = outSchema
if op.Responses[statusStr].Content["application/json"].Schema == nil {
op.Responses[statusStr].Content["application/json"].Schema = outSchema
}
}
}
if op.DefaultStatus == 0 {
Expand Down