Notes from the “Learn API Technical Writing 1” course

For more information, see Learn API Technical Writing: JSON and XML for Writers.

Exercises

• Exercise 1: JSON
• Exercise 2: JSON doc
• Exercise 3: XML
• Exercise 4: XML doc

1.2 Data types and structured Data

• JSON
  • Number, string (quotation marks), boolean (no quotation marks)
• XML
  • string
• Boolean
• Collections
  • Arrays - (list of data values)
  • Dictionaries (look up table)
    • Collection of data keys and values
• Structured data

2.4 What is JSON?

• Strings (single or double quotation marks)
• Numbers (integer, decimal, positive, negative)
• Booleans (no quotation marks)
• Null (no quotation marks)
• Arrays (lists)
  • Enclosed in square brackets
  • Can have mixed
• Objects (JSON’s dictionaries)
  • Enclosed in curly brackets
  • Key and values separated by a colon
  • Pairs separated by commas
• Nesting
  • Arrays, objects
• White space doesn’t matter

4.13 Structured data

• Swagger
• io docs
• XSD - XML schema

Resources

• http://www.freeformatter.com/xml-formatter.html