From the course: Learn API Documentation with JSON and XML
Join today to access over 22,600 courses taught by industry experts or purchase this course individually.
Documenting XML
From the course: Learn API Documentation with JSON and XML
Documenting XML
- [Instructor] Now let's go over how to document XML. Documenting XML is very similar to documenting JSON. In fact, many times an API can use both JSON and XML whereas in JSON an element was an object, in XML an element refers to a tag and what's contained inside that tag. Let me reiterate my caveat. There's no one standard way to document XML. What's described in this video is my favorite way based on years of experience. You might find a better way for the APIs that you document. Again, I suggest documenting one XML file and then getting approval from the project manager and the developers before writing all of the documentation. As I mentioned before, it's very common that an API can handle data in both JSON and XML. When an API request is made, it specifies which format to use. What you don't want to do is create separate tables for JSON and for XML because that would be a lot of redundant information so try to create one table that can capture both. To do this, use the same table…
Practice while you learn with exercise files
Download the files the instructor uses to teach the course. Follow along and learn by watching, listening and practicing.
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.