Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shahincsejnu/json-stuffs

Last synced: about 4 hours ago
JSON representation

Host: GitHub
URL: https://github.com/shahincsejnu/json-stuffs
Owner: shahincsejnu
Created: 2021-02-07T20:30:30.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2021-08-08T14:45:22.000Z (over 3 years ago)
Last Synced: 2024-06-21T18:02:38.399Z (5 months ago)
Language: Go
Size: 11.7 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# json-stuffs

This repository contains the stuffs related to JSON (or JSON in Golang to be specific).

## JSON

Click to expand

- JavaScript Object Notation
- Data representation format
- Commonly used for APIs and Configs
- Lightweight and easy to read/write
- It's a superset of JavaScript
- Integrates easily with most languages
- It's extension is `.json`

## JSON (Data) Types

Click to expand

- It supports `BASONN` types of data :
- `B` : Booleans, Ex: true, false etc.
- `A` : Arrays, Ex: [1, 2, 3], ["Hello", "World"] etc.
- `S` : Strings, Ex: "Hello World", "Shahin" etc.
- `O` : Objects, Ex: {"key" : }, {"age": 25} etc.
- `N` : Numbers, Ex: 1, 2, 1.5, -30, -3.5, 1.2e10 etc any time of numbers
- `N` : Null

## Syntax & Rules

Click to expand

- Need to provide `,` after the `"key": ,` pair (in json object) except the last one
- Ex:
```json
{
"Name" : "Shahin",
"Role" : "Software Engineer",
"ID" : 7,
"Male" : true
}
```

- JSON Objects can be nested, like :
- Ex:
```json
{
"Name" : "Shahin",
"Role" : "Software Engineer",
"ID" : 7,
"Male" : true,
"Profiles" : {
"LinkedIn" : "okaoka"
}
}
```

- JSON Objects can be represented in arrays, like :
- Ex:
```json
[
{
"Name" : "Shahin",
"Role" : "Software Engineer",
"ID" : 7,
"Male" : true,
"Profiles" : {
"LinkedIn" : "okaoka"
}
},

{
"Name" : "Oka"
}
]
```
- In this case also need to put `,` after every (parallel level) objects except the last one like the example above

- In a `"Key": ` pair of json object, the value can be any valid json data types type value, like:
- Ex:
```json
{
"Name" : "Shahin",
"Role" : "Software Engineer",
"ID" : 7,
"Male" : true,
"Skills" : ["Docker", "K8s", "Terraform"],
"Profiles" : {
"LinkedIn" : "okaoka"
}
}
```

- In an array we can put any types of values together, all values can be one type or multiple values can be put together, arrays represent by `[]` :
- Ex:
```json
[
{
"Name" : "Shahin",
"Role" : "Software Engineer",
"ID" : 7,
"Male" : true,
"Skills" : ["Docker", "K8s", "Terraform"],
"Profiles" : {
"LinkedIn" : "okaoka"
}
},

{
"Name" : "Oka",
"Skills" : ["Docker", true, "Terraform"]
}
]
```
- If in a `"key": ` pair of json object any field doesn't have any value then we can use `null` as the value, like:
- Ex:
```json
{
"Name" : "Oka",
"Skills" : ["Docker", true, "Terraform"],
"ID" : null
}
```

- If we want to use the json object as a string (json string), we need to surround the json object with back tick(``), like:
- Ex:
```
`[
{
"Name" : "Shahin",
"Role" : "Software Engineer",
"ID" : 7,
"Male" : true,
"Skills" : ["Docker", "K8s", "Terraform"],
"Profiles" : {
"LinkedIn" : "okaoka"
}
},

{
"Name" : "Oka",
"Skills" : ["Docker", true, "Terraform"],
"ID" : null
}
]`
```
- See `main.go` to know how to use this json string, how to parse (Marshal and Unmarshal in Go) them to a json (from json string to json) etc.

## JSON in Go

Click to expand

- Go offers built-in support for JSON encoding and decoding, including to and from built-in and custom data types.
- we can do `Marshal` and `Unmarshal` in Go for parsing JSON from and to struct etc.
- see the examples of Marshal and Unmarshal
- JSON Marshal in Go : Struct to JSON string
- JSON Unmarshal in Go : JSON String to Struct

## JSON metadata tag

- see this [article](https://build.vsupalov.com/go-json-omitempty/)
- see `json-metadata-tags-examples` folder's examples

# Resources

Click to expand

- [Learn JSON in 10 Minutes](https://www.youtube.com/watch?v=iiADhChRriM)
- [Working with JSON in Go - Tutorial](https://www.youtube.com/watch?v=Osm5SCw6gPU)
- [Go by Example: JSON](https://gobyexample.com/json)
- [Go JSON (Un)Marshalling, Missing Fields and Omitempty, JSON Metadata tag](https://build.vsupalov.com/go-json-omitempty/)
- [Go JSON doc](https://pkg.go.dev/encoding/json)