Skip to content

Commit

Permalink
Add custom json codec examples in doc file
Browse files Browse the repository at this point in the history
  • Loading branch information
timandy committed Apr 27, 2023
1 parent b04bddf commit 0b20d8b
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions docs/doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
- [http2 server push](#http2-server-push)
- [Define format for the log of routes](#define-format-for-the-log-of-routes)
- [Set and get a cookie](#set-and-get-a-cookie)
- [Custom json codec at runtime](#custom-json-codec-at-runtime)
- [Don't trust all proxies](#dont-trust-all-proxies)
- [Testing](#testing)

Expand Down Expand Up @@ -2123,6 +2124,66 @@ func main() {
}
```

### Custom json codec at runtime

Gin support custom json serialization and deserialization logic without using compile tags.

1. Define a custom struct implements the `api.JsonApi` interface.

2. Before your engine starts, assign values to `json.Api` using the custom struct.

```go
package main

import (
"io"

"github.com/gin-gonic/gin"
"github.com/gin-gonic/gin/codec/api"
"github.com/gin-gonic/gin/codec/json"
jsoniter "github.com/json-iterator/go"
)

var customConfig = jsoniter.Config{
EscapeHTML: true,
SortMapKeys: true,
ValidateJsonRawMessage: true,
}.Froze()

// implement api.JsonApi
type customJsonApi struct {
}

func (j customJsonApi) Marshal(v any) ([]byte, error) {
return customConfig.Marshal(v)
}

func (j customJsonApi) Unmarshal(data []byte, v any) error {
return customConfig.Unmarshal(data, v)
}

func (j customJsonApi) MarshalIndent(v any, prefix, indent string) ([]byte, error) {
return customConfig.MarshalIndent(v, prefix, indent)
}

func (j customJsonApi) NewEncoder(writer io.Writer) api.JsonEncoder {
return customConfig.NewEncoder(writer)
}

func (j customJsonApi) NewDecoder(reader io.Reader) api.JsonDecoder {
return customConfig.NewDecoder(reader)
}

func main() {
//Replace the default json api
json.Api = customJsonApi{}

//Start your gin engine
router := gin.Default()
router.Run(":8080")
}
```

## Don't trust all proxies

Gin lets you specify which headers to hold the real client IP (if any),
Expand Down

0 comments on commit 0b20d8b

Please sign in to comment.