httptreemux-swagger
github.com/dimfeld/httptreemux wrapper to automatically generate RESTful API documentation with Swagger 2.0.
Usage
Start using it
- Add comments to your API source code, See Declarative Comments Format.
- Download Swag for Go by using:
$ go get github.com/swaggo/swag/cmd/swag
- Run the Swag in your Go project root folder which contains
main.go
file, Swag will parse comments and generate required files(docs
folder and docs/doc.go
).
$ swag init
4.Download httptreemux-swagger by using:
$ go get -u github.com/swaggo/httptreemux-swagger
And import following in your code:
import "github.com/swaggo/httptreemux-swagger"
Canonical example:
package main
import (
"net/http"
"github.com/go-chi/chi"
"github.com/swaggo/httptreemux-swagger"
_ "github.com/swaggo/httptreemux-swagger/example/docs"
)
func main() {
r := chi.NewRouter()
r.Get("/swagger/*", httpSwagger.Handler(
httpSwagger.URL("http://localhost:1323/swagger/doc.json"),
))
http.ListenAndServe(":1323", r)
}
- Run it, and browser to http://localhost:1323/swagger/index.html, you can see Swagger 2.0 Api documents.