Modelando JSON em Classe C# com Visual Studio 2017

Quando se trabalha com APIs externas é muito comum se ter a necessidade de modelar o JSON recebido via requisição http em uma classe C#. Ao realizar tal transformação, torna-se possível a manipulação dos dados rebidos utilizando objetos em C# ao instanciar a classe modelada. É possível encontrar vários sites online que fazem essa transformação, como, por exemplo o Json2csharp. Mas você sabia que dá para fazer o mesmo utilizando o próprio Visual Studio? Neste post, vamos fazer um exemplo de como atingir esse resultado. Segue o passo a passo:

1) Capture um exemplo do JSON que você deseja transformar em classe C#
Com o endpoint da API em mãos, você pode copiar em um navegador e teclar enter para fazer uma requisição GET ao servidor. Assim, você receberá o Json como resposta. Outra maneira seria utilizar um software, como o Postman para realizar a sua requisição e obter o json. Assim, você obterá algo parecido como isso:

{ "id": 1, "name": "bulbasaur", "base_experience": 64, "height": 7, "is_default": true, "order": 1, "weight": 69, "abilities": [ { "is_hidden": true, "slot": 3, "ability": { "name": "chlorophyll", "url": "http://pokeapi.co/api/v2/ability/34/" } } ], "forms": [ { "name": "bulbasaur", "url": "http://pokeapi.co/api/v2/pokemon-form/1/" } ], "game_indices": [ { "game_index": 1, "version": { "name": "white-2", "url": "http://pokeapi.co/api/v2/version/22/" } } ], "held_items": [], "location_area_encounters": [], "moves": [ { "move": { "name": "captivate", "url": "http://pokeapi.co/api/v2/move/445/" }, "version_group_details": [ { "level_learned_at": 0, "version_group": { "name": "heartgold-soulsilver", "url": "http://pokeapi.co/api/v2/version-group/10/" }, "move_learn_method": { "name": "machine", "url": "http://pokeapi.co/api/v2/move-learn-method/4/" } }, { "level_learned_at": 0, "version_group": { "name": "platinum", "url": "http://pokeapi.co/api/v2/version-group/9/" }, "move_learn_method": { "name": "machine", "url": "http://pokeapi.co/api/v2/move-learn-method/4/" } }, { "level_learned_at": 0, "version_group": { "name": "diamond-pearl", "url": "http://pokeapi.co/api/v2/version-group/8/" }, "move_learn_method": { "name": "machine", "url": "http://pokeapi.co/api/v2/move-learn-method/4/" } } ] } ], "species": { "name": "bulbasaur", "url": "http://pokeapi.co/api/v2/pokemon-species/1/" }, "stats": [ { "base_stat": 45, "effort": 0, "stat": { "name": "speed", "url": "http://pokeapi.co/api/v2/stat/6/" } } ], "types": [ { "slot": 2, "type": { "name": "poison", "url": "http://pokeapi.co/api/v2/type/4/" } } ] }

2) Crie uma classe pelo Visual Studio.
Clique com o botão direito sobre mouse sobre o seu projeto e adicione uma classe a ele. Não vou dar detalhes de como criar um classe neste post (sorry!).

3) Apague o código referente a classe.
Tire o código referente a classe gerada automaticamente pelo VS. Ou seja, apague tudo que esteja dentro das chaves do namespace. Vai ficar algo parecido como isso:

using System; namespace Nome_Projeto { }

4) Copie o JSON que você tinha obtido e cole como uma classe.
Com o arquivo da sua classe aberta, clique no lugar onde você irá colar sua classe. Vá em Editar, depois em Colar Especial e, finalmente, clique em Colar JSON como classes. Pronto! Você não precisa mais utilizar geradores de classes online. O Visual Studio já faz tudo para você.

Abaixo segue como ficou o JSON após ser transformado em classe. =D

public class Rootobject { public int id { get; set; } public string name { get; set; } public int base_experience { get; set; } public int height { get; set; } public bool is_default { get; set; } public int order { get; set; } public int weight { get; set; } public Ability[] abilities { get; set; } public Form[] forms { get; set; } public Game_Indices[] game_indices { get; set; } public object[] held_items { get; set; } public object[] location_area_encounters { get; set; } public Move[] moves { get; set; } public Species species { get; set; } public Stat[] stats { get; set; } public Type[] types { get; set; } } public class Species { public string name { get; set; } public string url { get; set; } } public class Ability { public bool is_hidden { get; set; } public int slot { get; set; } public Ability1 ability { get; set; } } public class Ability1 { public string name { get; set; } public string url { get; set; } } public class Form { public string name { get; set; } public string url { get; set; } } public class Game_Indices { public int game_index { get; set; } public Version version { get; set; } } public class Version { public string name { get; set; } public string url { get; set; } } public class Move { public Move1 move { get; set; } public Version_Group_Details[] version_group_details { get; set; } } public class Move1 { public string name { get; set; } public string url { get; set; } } public class Version_Group_Details { public int level_learned_at { get; set; } public Version_Group version_group { get; set; } public Move_Learn_Method move_learn_method { get; set; } } public class Version_Group { public string name { get; set; } public string url { get; set; } } public class Move_Learn_Method { public string name { get; set; } public string url { get; set; } } public class Stat { public int base_stat { get; set; } public int effort { get; set; } public Stat1 stat { get; set; } } public class Stat1 { public string name { get; set; } public string url { get; set; } } public class Type { public int slot { get; set; } public Type1 type { get; set; } } public class Type1 { public string name { get; set; } public string url { get; set; } }

Caso você queira colocar o nome das propriedades com letra maísculas, basta decorá-las com  [JsonProperty("nomeQueVemDoJson")] acima delas. Por exemplo, se tem uma propriedade com o nome url e você quer colocar como Url, então é só fazer assim:

[JsonProperty("url")]
public string Url { get; set; }

Dessa maneira, você irá conseguir, por exemplo, utilizar o método get de Url com inicial maiúscula (respeitando o padrão) sem ter problemas com a desserialização do JSON que será recebido via API.