swag VS chi

Hey Gophers, I'm exploring Swagger generation for a REST API in Go (using go-chi). Currently, I'm testing https://github.com/swaggo/swag/, but I'm uncertain if it's the optimal solution. What are your thoughts or recommendations?

Swaggo is a tool that creates Swagger documentation for Go APIs. It makes documenting API endpoints easier, helping developers understand and use the API.

Some of the features: - ✅ Using Vertical Slice Architecture as a high level architecture - ✅ Using Event Driven Architecture on top of RabbitMQ Message Broker with a custom [Event Bus](pkg/messaging/bus/) - ✅ Using Event Sourcing in Audit Based services like [Orders Service](services/orders/) - ✅ Using CQRS Pattern and Mediator Patternon top of Go-MediatR library - ✅ Using Dependency Injection and Inversion of Controlon top of uber-go/fx library - ✅ Using RESTFul api with Echo framework and using swagger with swaggo/swag library - ✅ Using Postgres and EventStoreDB to write databases with fully supports transactions(ACID) - ✅ Using MongoDB and Elastic Search for read databases (NOSQL) - ✅ Using OpenTelemetry for collection Distributed Tracing with using Jaeger and Zipkin - ✅ Using OpenTelemetry for collection Metrics with using Prometheus and Grafana - ✅ Using Unit Test for testing small units with mocking dependent classes and using Mockery for mocking dependencies - ✅ Using End2End Test and Integration Test for testing features with all of their real dependeinces using docker containers (cleanup tests) and testcontainers-go library

[1]https://github.com/swaggo/swag/issues/386

I used this the other day and found it very easy to set up: https://github.com/swaggo/swag

I use the fizz for developing my webservices + docs, it's smooth! There is swaggo but I don`t like it because the source code get dirty (lots of comments)

You can use swaggo/swag with code annotations

checkout swaggo/swag.

I use go-chi for handling routes and to server static file(stylesheet).

This will be the structure of our project, we will use PostgreSQL as the database, go chi to create our endpoints, go dot env to import our environment variables.

go-chi: is a lightweight, idiomatic and composable router for building Go HTTP services.

Go Chi para criar nossas rotas

For HTTP I'd look at Chi https://github.com/go-chi/chi

In fact, it has zero dependencies outside of std lib in it's core: https://github.com/go-chi/chi/blob/master/go.mod

Interesting. go-chi added it as a middleware 4 months ago, but its not in the module docs since they haven't tagged a version since Dec 2022: https://github.com/go-chi/chi/blob/master/middleware/request_size.go