Giter VIP home page Giter VIP logo

Comments (19)

jarrodhroberson avatar jarrodhroberson commented on March 29, 2024 2

Is there a way to register a renderer for a custom MediaType?

I want to use something like application/vnd.myapp.person.json;version=1.0.0 as the "preferred" json format and application/json as a fallback.

from gin.

manucorporat avatar manucorporat commented on March 29, 2024 1

An API example:

func main() {
    r := gin.Default()
    r.GET("/hola", func(c *gin.Context) {
        data := gin.H{"status": "ok"}

        switch c.NegotiateFormat(gin.MIMEHTML, gin.MIMEJSON) {
        case gin.MIMEHTML:
            c.HTML(200, "resources/hola.tmpl", data)
        case gin.MIMEJSON:
            c.JSON(200, data)
        }
    })
}

by default, gin parses the Accept header.

If you want to change the behaviour, just add a middleware:

    r.Use(func(c *gin.Context) {
        var format struct {
            Format `form:"format"`
        }
        c.Bind(&format)

        switch format.Format {
        case "xml":
            c.SetNegotiatedFormat(gin.MIMEXML)

        case "json" || "":
            c.SetNegotiatedFormat(gin.MIMEJSON)

        default:
            c.Fail(406, "Not Acceptable")
        }
    })

resource?format=json

from gin.

manucorporat avatar manucorporat commented on March 29, 2024 1

An update:

    c.Negotiate(200, gin.Negotiate{
        Offered: []string{gin.MIMEJSON, gin.MIMEXML},
        Data:    jsonData,
        XMLData: xmlData,
    })

from gin.

manucorporat avatar manucorporat commented on March 29, 2024 1

gin/context.go

Lines 281 to 338 in 275bdc1

/************************************/
/******** CONTENT NEGOTIATION *******/
/************************************/
type Negotiate struct {
Offered []string
HTMLPath string
HTMLData interface{}
JSONData interface{}
XMLData interface{}
Data interface{}
}
func (c *Context) Negotiate(code int, config Negotiate) {
result := c.NegotiateFormat(config.Offered...)
switch result {
case MIMEJSON:
data := chooseData(config.JSONData, config.Data)
c.JSON(code, data)
case MIMEHTML:
data := chooseData(config.HTMLData, config.Data)
if len(config.HTMLPath) == 0 {
panic("negotiate config is wrong. html path is needed")
}
c.HTML(code, config.HTMLPath, data)
case MIMEXML:
data := chooseData(config.XMLData, config.Data)
c.XML(code, data)
default:
c.Fail(400, errors.New("m"))
}
}
func (c *Context) NegotiateFormat(offered ...string) string {
if c.accepted == nil {
c.accepted = parseAccept(c.Request.Header.Get("Accept"))
}
if len(c.accepted) == 0 {
return offered[0]
} else {
for _, accepted := range c.accepted {
for _, offert := range offered {
if accepted == offert {
return offert
}
}
}
return ""
}
}
func (c *Context) SetAccepted(formats ...string) {
c.accepted = formats
}

from gin.

Athosone avatar Athosone commented on March 29, 2024 1

@arthurlaveau I did,

I wrote a library to solve the issue. It works with the base go net package.
It works natively with gorilla mux and go-chi.
it could work with gin gonic with a little effort. If you want to contribute feel free
Check the example: https://github.com/Athosone/golib/tree/main/examples/media-type-versioning

from gin.

manucorporat avatar manucorporat commented on March 29, 2024

Interesting!

Anyway, /api/?format=xml/json, api.json/xml do not look very standard.
But using the Accept header looks interesting.

Idea, we could add a:
c.Render(code, binding, data)
it should be used like this:

c.Render(200, binding.JSON, data)

and then add a stric-Accept middleware.

from gin.

pinscript avatar pinscript commented on March 29, 2024

I'm going out of town for at least a week (vacation :)), so if anyone want to jump in on this, please do.

from gin.

k2xl avatar k2xl commented on March 29, 2024

Yeah this popped out at me about gin. I guess I could create a middleware encoder that has the negotiation after the .Next, but it seems like this should be something that is done automatically by gin.

from gin.

jmillerdesign avatar jmillerdesign commented on March 29, 2024

I'm interested in this feature as well. It would be nice to have the control to manipulate the response for each format as well.

from gin.

austinheap avatar austinheap commented on March 29, 2024

👍 to @alexandernyquist's request for content negotiation

from gin.

manucorporat avatar manucorporat commented on March 29, 2024

I have a proposal for Content Negociation in Gin:

func (c *Context) NegotiatedFormat() string {
     if c.negotiatedFormat != "" {
         // Evaluate Accept header
         c.negotiatedFormat = "application/json" or "application/xml" or "text/html" ...
     }
     return c.negotiatedFormat
}

This method is lazily initialized, so the performance will not be affected in the current implementation.
It represents the default content negotiation policy but it can be changed with a middleware by calling:

func (c *Context) SetNegotiatedFormat(format string) {
     c.negotiatedFormat = format
}

from gin.

Thomasdezeeuw avatar Thomasdezeeuw commented on March 29, 2024

How about accepting a file extention in the url like /api/resource.json and /api/resource.xml?

from gin.

manucorporat avatar manucorporat commented on March 29, 2024

How about accepting a file extention in the url like /api/resource.json and /api/resource.xml?

Two ideas:

  1. Using params
func main() {
    r := gin.Default()
    r.Use(func(c *gin.Context) {
        extension := c.Params.ByName("ext")
        switch extension {
        case "json":
            c.SetNegotiatedFormat(gin.MIMEJSON)
        case "xml":
            c.SetNegotiatedFormat(gin.MIMEJSON)
        default:
            c.Fail(400, "unknown extension")
        }
    })
    r.GET("/resource.:ext", func(c *gin.Context) {
        data := gin.H{"status": "ok"}

        switch c.NegotiateFormat(gin.MIMEJSON, gin.MIMEXML) {
        case gin.MIMEXML:
            c.XML(200, data)
        case gin.MIMEJSON:
            c.JSON(200, data)
        }
    })
}
  1. Using several routes and inspecting the extension:
package main

import "fmt"
import "github.com/gin-gonic/gin"
import "path/filepath"

func main() {
    r := gin.Default()

     // Create a route group, so this middleware is just applied to this group
    negotiation := r.Group("/", func(c *gin.Context) {
        switch filepath.Ext(c.Request.URL.Path); {
        case "json" || "":
            c.SetNegotiatedFormat(gin.MIMEJSON)
        case "xml":
            c.SetNegotiatedFormat(gin.MIMEJSON)
        default:
            c.Fail(400, "unknown extension")
        }
    })
    negotiation.GET("/hola.json", resourceHandler)
    negotiation.GET("/hola.xml", resourceHandler)

    r.Run(":8080")
}

func resourceHandler(c *gin.Context) {
    switch c.NegotiateFormat(gin.MIMEJSON, gin.MIMEXML) {
    case gin.MIMEXML:
        c.XML(200, data)
    case gin.MIMEJSON:
        c.JSON(200, gin.H{"status": "ok"})
    }
}

from gin.

manucorporat avatar manucorporat commented on March 29, 2024

I am also testing a new API:

    c.Negotiate(200, gin.H{
        "html.file": "resouces/resource.tmpl",
        "xml.data":  xmlData,
        "*.data":    jsonData,
    })

from gin.

manucorporat avatar manucorporat commented on March 29, 2024

Content.Negotiate()

  1. Calls c.NegotiateFormat() internally
  2. Based in the config map, it renders HTML, XML or JSON in a efficient way.

This is extremely flexible, since you can:

  1. Change the default HTML render, using engine.HTMLRender = render
  2. You can change the negotiation algorithm as explained previously using middlewares.
  3. It doesn't add performance overhead
  4. Short, imperative and powerful API

from gin.

phisco avatar phisco commented on March 29, 2024

I think it could be useful to allow extensions to the Negotiate method, because for example the default being an error could not be the best option for everyone, but as it is it is not possible to modify it, without modifying the library code.

from gin.

Athosone avatar Athosone commented on March 29, 2024

@jarrodhroberson did you find a way to achieve mediatype versioning?

from gin.

arthurlaveau avatar arthurlaveau commented on March 29, 2024

@Athosone about you ? Did you find a way to achieve it ?

from gin.

arthurlaveau avatar arthurlaveau commented on March 29, 2024

@Athosone thank you for your answer. I will take a look at it!

from gin.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.