GoLand
 
2023.2
Shortcuts: Windows
Get GoLand
You are viewing the documentation for an earlier version of GoLand.
  1. Write and edit source code
  2. Go editing
  3. 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/2023.2/go_converting_json_to_struct.png
Gif

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

Generate struct fields

  1. Press CtrlShift0A to invoke the Go to Action search.

  2. Search for the Generate Go Type from JSON option and run it.

  3. Paste or write your JSON in the text field.

  4. Click Generate.

    https://resources.jetbrains.com/help/img/idea/2023.2/go_modify_json_for_a_struct_in_a_separate_dialog.png
    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

  1. Click a struct field and press AltEnter.

  2. Select Add key to tags.

    https://resources.jetbrains.com/help/img/idea/2023.2/go_add_new_tags_to_a_struct_field.png
    Gif

Modify keys in field tags

  1. Click a struct field and press AltEnter.

  2. Select Update key value in tags.

    https://resources.jetbrains.com/help/img/idea/2023.2/go_modify_keys_in_field_tags.png
    Gif

Change code style of tag keys

  1. Click a key in tag and press AltEnter.

  2. Select Change field name style in tags.

    https://resources.jetbrains.com/help/img/idea/2023.2/go_change_code_style_of_tag_keys.png
    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.

code-completion-json

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.

    https://resources.jetbrains.com/help/img/idea/2023.2/go_autocompletion_for_struct_tags.png
    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.

https://resources.jetbrains.com/help/img/idea/2023.2/go_generate_fields_for_an_empty_struct.png
Gif