From the course: Learn API Documentation with JSON and XML

Unlock the full course today

Join today to access over 22,600 courses taught by industry experts or purchase this course individually.

Documenting JSON solution

Documenting JSON solution

From the course: Learn API Documentation with JSON and XML

Start my 1-month free trial

Documenting JSON solution

“

- [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,"…

Contents