JSON Instance Settings

A JSON (JavaScript Object Notation) Instance contains JavaScript-based data structures that are most commonly used for data-interchange between AJAX components and web services. TechWriter supports documenting JSON data structures by inferring the underlying schema from an instance. For more information on JSON visit www.json.org.

When you add a JSON Instance source to your project, TechWriter displays the following dialog.

Use this dialog to specifying the location of the JSON Instance File you would like to document. The location may be either a local file or a web address.

Tip: Make sure your JSON Instance contains data for every possible item in your data structure. Anything missing from the instance file from the inferred schema.