Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/limiu82214/gojmapr
get simple struct from complex json
https://github.com/limiu82214/gojmapr
Last synced: 2 months ago
JSON representation
get simple struct from complex json
- Host: GitHub
- URL: https://github.com/limiu82214/gojmapr
- Owner: limiu82214
- License: mit
- Created: 2023-04-04T13:47:00.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-06-21T02:59:07.000Z (about 1 year ago)
- Last Synced: 2024-01-27T08:38:28.634Z (5 months ago)
- Language: Go
- Size: 33.2 KB
- Stars: 22
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-go - gojmapr - Get simple struct from complex json by json path. (JSON / Search and Analytic Databases)
- awesome-go-cn - gojmapr
- awesome-go-cn - gojmapr
- awesome-go-stars - gojmapr(stars: 22) - Get simple struct from complex json by json path. (JSON / Search and Analytic Databases)
- awesome-go-with-stars - gojmapr - Get simple struct from complex json by json path. (JSON / Search and Analytic Databases)
- awesome-go - gojmapr - Get simple struct from complex json by json path. (JSON / Search and Analytic Databases)
- awesome-go - gojmapr - Get simple struct from complex json by json path. (JSON / Search and Analytic Databases)
- awesome-go - gojmapr - Get simple struct from complex json by json path. (JSON / Search and Analytic Databases)
README
# gojmapr
 [](https://pkg.go.dev/github.com/limiu82214/gojmapr) [](https://opensource.org/licenses/MIT) [](https://codecov.io/gh/limiu82214/gojmapr) [](https://goreportcard.com/report/github.com/limiu82214/gojmapr)  [](https://github.com/avelino/awesome-go)
[中文版文檔](./README_ZH.md)
gojmapr is a Golang library that allows for quick extraction of specified properties from complex JSON strings and converts them into corresponding Go structures.
With gojmapr, you don't need to declare a complete Go structure that corresponds to the entire JSON structure, just provide the required properties.
This makes gojmapr particularly useful for extracting specific data when accessing third-party resources, making your code more concise and readable.
## Features
Easy to use: Easily extract required properties from JSON strings by adding a few tags.
Supports nested properties: Easily extract required properties from JSON strings with multiple nested levels.
## Installation
To use gojmapr, first add it to your Golang project:
```go
go get github.com/limiu82214/gojmapr
```
## Usage
To use the gojmapr library, simply import it into your code and follow these steps:
Define a struct that corresponds to the JSON string you want to parse.
Add the gojmapr tag to each property in the struct to specify the path to extract the property from the JSON string (reference jpath).
Use the gojmapr.Unmarshal function to parse the JSON string into a struct object.
## Example
Here's a simple example that shows how to use the gojmapr library to extract properties from a JSON string.
```go
package main
import (
"fmt"
"github.com/limiu82214/gojmapr"
)
func main() {
jsonString := `{
"user": {
"name": "John",
"email": "[email protected]"
},
"cart": {
"items": [
{
"product": {
"id": "123",
"name": "Product A",
"description": "Product A description",
"price": 10.99
},
"quantity": 2
},
{
"product": {
"id": "456",
"name": "Product B",
"description": "Product B description",
"price": 5.99
},
"quantity": 1
}
],
"total": 27.97
},
"shipping": {
"method": "standard",
"address": {
"street": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip": "12345"
},
"fee": 5.99
},
"create_at": "2020-01-01T00:00:00Z"
}`
type tmpStruct struct {
Name string `gojmapr:"user.name"`
}
var s tmpStruct
err := gojmapr.Unmarshal([]byte(jsonString), &s)
if err != nil {
panic(err)
}
fmt.Println(s.Name) // Output: John
type tmpStruct2 struct {
ID string `gojmapr:"$.cart.items[0].product.id"`
Price float64 `gojmapr:"$.cart.items.0.product.price"`
}
var s2 tmpStruct
err := Unmarshal([]byte(jsonString), &s2)
if err != nil {
panic(err)
}
fmt.Println(s2.ID) // Output: 123
fmt.Println(s2.Price) // Output: 10.99
}
```
More examples of usage can be found in the test code in the project.
## Use other Unmarshal package
```go
import jsoniter "github.com/json-iterator/go"
type tmpStruct struct {
RequestID string `gojmapr:"$.request_id"`
}
SetUnmarshalFunc(jsoniter.Unmarshal) // You can use other Unmarshal module ex: json-iterator
var s tmpStruct
err := Unmarshal([]byte(jsonString), &s)
ex.Assert().Nil(err)
ex.Assert().Equal(ex.anserStruct.RequestID, s.RequestID)
```
gojmapr can use other Unmarshal package ex: json-iterator.
## Testing
gojmapr uses the testify package for testing.
To run the tests, use the following command:
```bash
go test -v ./...
```
## Dependency
* [github.com/limiu82214/gojpath](http://github.com/limiu82214/gojpath)
## Other
If you encounter any issues during use, please feel free to raise an issue on the GitHub project or contact me via email.
If you find this project helpful, please consider giving it a star.
## LICENSE
[MIT License](./LICENSE)