From the course: Programming Foundations: APIs and Web Services
Join today to access over 22,600 courses taught by industry experts or purchase this course individually.
Document an API
From the course: Programming Foundations: APIs and Web Services
Document an API
- [Instructor] Let's talk about documenting an API. What we are going to look at is very useful for developers and software engineers that need to consume or use an existing web service in their applications. Swagger is the tool of choice for documenting an API and it's a tool that allows you to understand how an API works. When creating a REST API, good documentation is instrumental and keeping that documentation updated with every new change is also instrumental. Accomplishing this manually is a tedious exercise. So automation, via Swagger, is a time-saver. And so this is just an example from the Swagger Petstore example that shows the API and all of the different features and operations on it. Now more about Swagger. Swagger is a set of open-source tools built around the OpenAPI Specification and I'm showing the specification here. So this specification defines a standard and it's programming language-agnostic and it's…
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.