swag VS oapi-codegen

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.

what’s the difference between this and https://github.com/deepmap/oapi-codegen

During daytime, and especially work time, I used a great tool to generate code from OpenAPI specification: deepmap/oapi-codegen.

Then you can use oapi-codegen or openapi-generator to generate the Go (or other language) SDK for it.

Deepmap OpenAPI code generator

Luckily, Forem/DEV is open source and provides great API documentation and specification. I used oapi-codegen to automatically generate a Go API client. Then, I simply had to walk the root articles directory and:

I'm using https://github.com/deepmap/oapi-codegen to auto gen some types for my api as I want the contract to be the source of truth. However, I'm running into an issue, the same as (https://stackoverflow.com/questions/77237210/how-to-generate-models-from-openapi-with-ref) where oapi-codegen isn't recognizing references to local files. Has anyone run into this and found a work around? or is there a better tool to use for this

For Go, I've found https://github.com/deepmap/oapi-codegen/, and it works well.

I’m using oapi-codegen in my project and I don’t think it ships with a validator.