Write and edit source code
Go editing
Working with JSON

Working with JSON

Last modified: 04 October 2021

JavaScript Object Notation (JSON) is a textual format in which you can represent, store, and transfer structural data.

In Go, map and struct data types provide the closest JSON representation as they can store data in a key:value format.

When you paste JSON in GoLand, the IDE suggests converting it to the struct type. All the necessary struct field tags are generated and added automatically.

https://resources.jetbrains.com/help/img/idea/2022.2/go_converting_json_to_struct.png

You can use the copy-and-paste approach or the Generate Go Type from JSON dialog.

Generate struct fields

Press Ctrl+Shift+A to invoke the Go to Action search.
Search for the Generate Go Type from JSON option and run it.
Paste or write your JSON in the text field.
Click Generate.
Gif

Intention actions

By using intention actions, you can add new tags, keys and modify the code style of tag keys.

Add new tags to a struct field

Click a struct field and press Alt+Enter.
Select Add key to tags.
Gif

Modify keys in field tags

Click a struct field and press Alt+Enter.
Select Update key value in tags.
Gif

Change code style of tag keys

Click a key in tag and press Alt+Enter.
Select Change field name style in tags.
Gif

Code completion

When you modify tag keys, GoLand displays a list of the most popular values for these tags. For example, json suggests omitempty; xml has attr, cdata, chardata, innerxml, and others; asn1 has optional, explicit, generalized, and so on.

Style for struct tags

When you start filling out a tag, right after you type backticks (`), GoLand will suggest entering a key. Press Tab or Enter and you will see a list of options. Choose the style of the value name. The IDE saves your choice, and it will suggest the same style first in the list for other fields of this struct.
Gif

Generate fields for an empty struct

If you have an empty struct, you can generate all the necessary fields and tags from JSON. To do that, call the Generate Go Type from JSON dialog by using the Go to Action search and paste your JSON in the text field. Alternatively, you can navigate to Code | Generate and select Type from JSON in the popup window.

Thanks for your feedback!

Was this page helpful?

Working with JSON﻿

Generate struct fields﻿

Intention actions﻿

Add new tags to a struct field﻿

Modify keys in field tags﻿

Change code style of tag keys﻿

Code completion﻿

Style for struct tags﻿

Generate fields for an empty struct﻿