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 one-level JSON responses

Documenting one-level JSON responses

From the course: Learn API Documentation with JSON and XML

Start my 1-month free trial

Documenting one-level JSON responses

“

- [Narrator] Let's take a look at how to document JSON. We'll start by looking at single-level responses. So as I said, we're going to start with the simplest of JSON files, which is data with no nesting. In other words, we'll just have one object with some key-value pairs. Everything will be on one level. Before we get into the details, let me first give you a caveat. There is no one standard way to document JSON. What's described in this lesson is my own favorite way, based on my years of experience. You might find a better way for the APIs that you document. I suggest documenting one JSON file and then getting approval from the project manager and the developers before writing all of the documentation. That said, I document each JSON structure with a sentence that describes what it represents and then I use one or more tables. The columns of the tables contain the key names, description, and type. If you need to, you can have a column that includes additional information, which I…

Contents