Home
Do you know how to easily get classes from a JSON response?
  v4.0 Posted at 23/10/2020 1:26 PM by Matt Goldman
​​When integrating with external Web APIs which return a JSON response, there is a quick and easy way to generate classes to handle that response.


If the API specification is published as per ​our rule: Do you document your Web API?

You can automatically generate your classes from that specification. See our other rule on how to do this: Do you know the best way to generate your classes from swagger?

If the specification isn't publised you need to generate your clases from the response you get from calling the API. Here is a trick to do that.

​Execute the request, and copy the text of the JSON response.

8-08-2014-3-41-23-PM-compressor.png

Create a new class in Visual Studio, and Click Edit | Paste Special | Past As JSON Classes and classes will be generated from the JSON in the clipboard.

8-08-2014-3-53-17-PM-compressor.png
Figure: Edit | Paste Special | Paste JSON As Classes

8-08-2014-3-56-34-PM-compressor.png
Figure: Classes generated from the JSON

The results may need cleaning up a little bit, but its much easier than trying to write them manually.


Related rules

    Do you feel this rule needs an update?

    If you want to be notified when this rule is updated, please enter your email address:

    Comments: