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.
Next steps
- [Instructor] Now that you know how to document JSON in XML, I'm going to talk about the next steps to learn how to be able to document web APIs. We've been focusing on JSON and XML, which are a big piece of API documentation. Depending on the style of API, there are other pieces of information you'll need to document. For example, you may need to describe authentication and query parameters. We've been focused on detailed reference materials for APIs, but you can also create overview materials. I've found that the people who create an API often get lost in the details when describing it. They forget that developers can't just jump into the details. Your job is to write the overview material to orient the reader. How can you learn these next steps? The I'd Rather Be Writing website contains a useful text-based course called Documenting REST APIs. REST is a commons style of Web API. Also spend some time looking at existing API documentation. The documentation for stripe.com is…
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.