Standard Open API Rendering

[rwithers]

Hello,

I may be missing something but I can't seem to figure out how to get the open api spec to render without the stoplight wrapper. Seems like hello-world@latest has it but I don't know that I've found a reference to that.

I will keep looking and respond if I find it.

Any guidance would be appreciated.

Thanks,

Ryan

[dylanhitt]

Take a look at the WithOpenAPIConfig option. There's a field UIHandler where you can pass your handler.

[rwithers]

Yeah I'm curious if you run the

go run github.com/go-fuego/fuego/examples/hello-world@latest

It comes back with swagger running without the stoplight rendering around it all. That's what I'm after.

The other alternative would be some guidance on overriding the default landing page for the stoplight stuff.

I definitely need to keep reading.

[dylanhitt]

Oh I see now.

That's because go run github.com/go-fuego/fuego/examples/hello-world@latest is building an older version. If you

go run github.com/go-fuego/fuego/examples/hello-world@main

It will be the stoplight UI. I imagine a reason for the switch was to remove the httpswagger dep from fuego. I was able to get the the base swagger ui working with something like this

package main

import (
	"net/http"

	"github.com/go-fuego/fuego"
	httpSwagger "github.com/swaggo/http-swagger"
)

func openApiHandler(specURL string) http.Handler {
	return httpSwagger.Handler(
		httpSwagger.Layout(httpSwagger.BaseLayout),
		httpSwagger.PersistAuthorization(true),
		httpSwagger.URL(specURL), // The url pointing to API definition
	)
}

func main() {
	s := fuego.NewServer(
		fuego.WithOpenAPIConfig(fuego.OpenAPIConfig{
			UIHandler: openApiHandler,
		}),
	)
        s.OpenApiSpec.OpenAPI = "3.0.3"

	fuego.Get(s, "/", helloWorld)

	s.Run()
}

func helloWorld(c fuego.ContextNoBody) (string, error) {
	return "Hello, World!", nil
}

One thing to note is that swaggo/http-swagger package doesn't support openapi 3.1 hence why you have to override the openapi version at least starting with fuego > 0.14

Hopefully that helps you out

[EwenQuim]

@rwithers You may have missed it but it was in the docs!

I'm curious why you don't like the Stoplight interface? Can't wait to find out, maybe we chose the wrong default option?

---

@dylanhitt I still see different actions we could do here

• Having a script to automatically bump examples with new tags, so each time a new Fuego version is out, the examples are updated at @latest and not only @main
• Making it clear in the docs that we can just write this to disable OpenAPI config

app := fuego.NewServer(
	fuego.WithOpenAPIConfig(fuego.OpenAPIConfig{
		DisableSwagger:   os.Getenv("ENV") != "dev",
		DisableLocalSave: os.Getenv("ENV") != "dev",
	}),
)

• Mark the version as 3.0.x instead of 3.1, I didn't think that swaggo/http-swagger and other tools might no support openapi3.0-friendly openapi3.1 specs.
• Create another example without using swaggo/http-swagger but using a std custom handler to make it more clear how one could do this

What do you think about it ?

[dylanhitt]

Making it clear in the docs that we can just write this to disable OpenAPI config

Yeah, I did just realize the DisableSwagger doesn't necessarily stop the saving of the doc. Which it probably should.. I'll make PR if you agree.

Create another example without using swaggo/http-swagger but using a std custom handler to make it more clear how one could do this

I think is the best course of action

[dylanhitt]

@rwithers was this answered? Or can we provide some more clarification.