swaggerui VS swag

I have been playing with this functionality in my library, which currently just turns the header off. Haven't used swaggo/swag before, but it looks like they bundle the UI file assets into a separate package that embeds them using another tool and then they generate a handler for you.

Have a look at https://github.com/flowchartsman/swaggerui or one of the forks.

I would probably put my embed and generate directives in the same file for convenience, then I would write a package main file that does your minification work(if you can). Take a look at what I did here. It’s actually a full binary to download the code, and go generate will call it. In your case, this would be your minifier. You would need to make sure you call “go generate” before “go build” if you’ve made any changes to code that might need minified. Mage might be a good option to help you with this, since, unlike the embed directive, generate directives must be manually called.

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.