Join Peter Gruenbaum for an in-depth discussion in this video Documenting JSON solution, part of Learn API Documentation with JSON and XML.
- [Narrator] Now let's take a look at the solution…to the JSON Documentation Exercises.…We'll start with the first one,…which is for the weather forecast for one day.…This is what the final solution should look like.…Not exactly, but this is my interpretation anyway.…So, you start with one sentence,…which represents the weather forecast for one day,…and then there's a table, and it's got those four columns:…Element, Description, Type and Notes.…Let's go to the underlying markdown.…The main thing to note on this…is that what we put in the Notes column…is important information about the data…that doesn't really fit as well in the other columns.…
So, for example, the format.…Here's the format for the date.…And then for the description, the description has…certain valid values, so I list those here.…Valid values of sunny, overcast, partly cloudy,…and so forth.…Any time there's a unit,…for example the maximum temperature,…I put "In degrees Celsius."…Wind speed is "In kilometers per hour," and so forth.…And then the last one, danger, is of type "Boolean."…
- 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
Skill Level Intermediate
Project Management: Iterative Methodswith Bob McGannon1h 16m Intermediate
Technical Writing: Reportswith Judy Steiner-Williams2h 30m Intermediate
Introduction to JSON and XML Documentation
Next steps1m 10s
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.