Using the same endpoint for serving a Template and a JSON response

I would like to serve an HTML page when the accept header is set to text/html and serve a JSON object when the accept header is set to application/json.

Is that possible? If so, what should I set the response_class to?

[tiangolo]

Thanks for the help here @includeamin and @Kludex ! 🙇

And thanks for the discussion everyone!

@augusto-herrmann interesting, this would mean that routing would depend not only on path and HTTP operation but also on a specific header, content-type. I’ve seen others also want other things to be taken into account when routing. E.g. a header defining the version of the app to use, or things like that. I’m still not sure about it, as it’s a lot of extra complexity, to deal with, to code, to maintain, to explain, for users to learn, and I’m not sure the benefits are worth it.

But anyway, maybe you could create an independent issue with your specific feature request.

I think the ideas here would solve the original problem from @amjith, right? If that’s the case, then you can close the issue. 🤓

Sorry for the long delay! 🙈 I wanted to personally address each issue and they piled up through time, but now I’m checking each one in order.

[acmpo6ou]

Hi!

I’ve implemented the @html_or_json decorator that you can put on your path operation functions to make them return json when the accept header of request is application/json or render Jinja2 template if the accept header is text/html.

You can find the code here html_json.py contains code for the decorator and main.py contains some examples on how to use the decorator.

Hope this helps somebody!