Best practice to use other services (e.g. db client, s3 client) in route handler about huma HOT 6 CLOSED

@JanRuettinger my recommendation is quite similar to your original example, in that you have a wrapper object to track the dependencies and then register your operations from it so they have access to those dependencies. Something like this:

type HelloServer struct {
	DB DBType
	S3 S3Type
}

func NewHelloServer(db DBType, s3 S3Type) *HelloServer {
	return &HelloServer{
		DB: db,
		S3: s3,
	}
}

func (s *HelloServer) RegisterHello(api huma.API) {
	huma.Register(api, huma.Operation{
		OperationID: "get-greeting",
		Summary:     "Get a greeting",
		Method:      http.MethodGet,
		Path:        "/greeting/{name}",
	}, func(ctx context.Context, input *GreetingInput) (*GreetingOutput, error) {
		// TODO: use dependencies here as s.DB or s.S3
		return nil, nil
	})
}

func main() {
	db := NewDB()
	s3 := NewS3()
	hello := NewHelloServer(db, s3)
	
	router := chi.NewMux()
	api := humachi.New(router, huma.DefaultConfig("My API", "1.0.0"))

	huma.AutoRegister(api, hello)

	http.ListenAndServe(":8888", router)
}

The HelloServer would group all the operations related to the "Hello" feature or which need those same dependencies. You can have many different servers registered to a single API. This setup also makes testing easier since you can use dependency injection with mocks.

Hopefully this answers your question!

from huma.

@Mastermjr you could try submitting a PR after modifying the files at https://github.com/danielgtaylor/huma/tree/main/docs. Running the docs locally is pretty easy:

# First, make sure you have Python installed, then grab the doc generator
$ pip install mkdocs-material

# Then run the docs locally
$ cd huma/docs
$ mkdocs serve

Should be running at http://localhost:8000/.

Separately, I'm working on a new example API to show off a bunch of features, project layout, testing, integration with DBs/Queues/etc, webhooks/SSE and stuff like that. It's in the early stages but I'm hoping to get something working within the next few weeks that can act as an example for people to learn from.

from huma.

How is the reference related to the issue?

from huma.

How could I get this added to the docs so others can reference this in the future?
When I've been learning how I want to adopt this project, its been difficult to figure out how I want to design my application so its easy to maintain
I know this issue is closed, so I'm happy to open a new one under this same topic

from huma.

@Mastermjr you could try submitting a PR after modifying the files at https://github.com/danielgtaylor/huma/tree/main/docs. Running the docs locally is pretty easy:

# First, make sure you have Python installed, then grab the doc generator
$ pip install mkdocs-material

# Then run the docs locally
$ cd huma/docs
$ mkdocs serve

Should be running at http://localhost:8000/.

Separately, I'm working on a new example API to show off a bunch of features, project layout, testing, integration with DBs/Queues/etc, webhooks/SSE and stuff like that. It's in the early stages but I'm hoping to get something working within the next few weeks that can act as an example for people to learn from.

Yes please!

from huma.

I've gotten pulled into other things, when I get my PoC working I'll see how I can translate it into a post and get it put up here.
Would actually like some comments on how I've designed the endpoints.
Posting this publically so that I'm more inclined to follow through on this :)

from huma.