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.
Using structured data for documentation
From the course: Learn API Documentation with JSON and XML
Using structured data for documentation
- [Instructor] Up until now we've been talking about how to document structured data. Now I want to briefly talk about how you can use structured data for documentation itself. There are tools that take structured data and generate documentation from them. And now that you understand Json and XML, you'll be in better shape to create documentation for these tools. When you create documentation using structured data, then the documentation is machine readable. Essentially a computer can read it in and do something with it beyond just presenting it to a reader. For example, it can do automated testing, and make sure that every element in a Json file has some kind of description in it's documentation. It can also create interactive documentation, where you can try out an API call from within the documentation. Creating documentation from structured data is called autogenerated documentation. Let me show you an example. This is autogenerated documentation using a tool called Swagger. This…
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.