In this course, you will be asked to write JSON and XML files. Even though it's uncommon in the industry to write these files by hand, this will give you a good understanding of how these file formats work. This video provides you with information on tools that are good for writing these file formats.
- [Narrator] As part of this course, you'll be creating JSON and XML files. What tools will you need to create those files? JSON and XML are simply text formats. This means that you can always just use the text editors that come with your operating system. For example, for Windows, you can use Notepad. For Mac OS, you can use TextEdit. There are more sophisticated text editors available. These editors can often validate files and show you where they do not have the correct form, and even format them so that they look nice.
For Windows, Notepad++ is an easy to use, powerful editor that is free. For both Mac and Windows, Sublime Text is a very good tool, and I'll use it in this course. It's not free, but there is a free trial version that you can use. Let me show you how to get it. So, this is the Sublime Text website. It's at sublimetext.com and just click on the download button and you'll see that there's downloads for every operating system. Sublime Text is often updated, so what you see here, may be different than what you see when you go to the website.
But any version of Sublime Text should work. In fact, you can use any text editor you like. And you should be able to follow along in the course just fine. Finally, there are editors that are designed specifically for JSON and XML. These can be quite nice to use but might be overkill for this course. To find them, just do a web search on JSON editor or XML editor. Some of these editors are online, so you'd be typing your JSON and XML into the browser. So, this is JSON Editor Online and you can see that you can type your JSON in on the left side.
And it's great example of some of the online tools that are available.
- The purpose of documentation
- Data types
- Structured data
- Writing JSON and XML
- Documenting one-level JSON responses
- Documenting nested JSON responses
- XML attributes and examples
- Documenting XML
- Structuring data documentation