Multi return

[EwenQuim]

Spec

Currently, return type is either JSON or XML for the whole app. This needs to be improved.

The route /recipes should send HTML with a list of recipes if the Accept Header is "text/html", or JSON if the Accept Header is "application/json", or XML if the Accept Header is "application/xml". This allows to build a traditional website in the same time as building an API.

This change is of course backward-compatible and existing controller will not change current behaviour. Performance should also not be degraded.

Example

A controller might look like this (see multi_return_test.go for more examples).

fuego.Get(s, "/data", func(c ContextNoBody) (DataOrTemplate[MyType], error) {
	entity := MyType{Name: "Ewen"}

	return DataOrTemplate[MyType]{
		Data: entity, // Used when asking for JSON or XML
		Template: MyTemplate(entity) // std template, Templ or Gomponent rendered when asking for HTML
	}, nil
})

[EwenQuim]

This is a lot cleaner and I think it is ready to merge. Examples of the new features in _test.go files.

Another thing is missing : when using this new DataOrTemplate structure, the generated OpenAPI spec is a bit buggy. But I'll fix this after reviewing PR #134, since it is very deeply linked. What do you think about this @dylanhitt ?

[dylanhitt]

Will look at it at the end of the week. 😄

[EwenQuim]

Ready for review ✅

The generated OpenAPI schema should be correct.

When using DataOrTemplate[MyType], OpenAPI spec will only see MyType as it is the type return by JSON/XML APIs, the template is ignored.

This allow to work on classic "view" (from MVC pattern) routes and create an API at the same time. I was playing with this feature the last few weeks and it is very helpful.

[dylanhitt]

Will be looking at this Sunday night. Day job got in the way this week

[dylanhitt]

This is super clean and very clear. Just a few comments to address.