In this video, learn how to create interactive API documentation using Swagger UI in combination with an OAS API definition file.
- [Instructor] Once we've built an API definition file, … we can automatically generate interactive documentation … from the file using Swagger UI. … To get started, we just need to save our API definition … from Swagger Editor. … To do this, we click on the file option within the menu … and then click on Save as YAML. … This is going to open a dialog where we can then save … our API definition file. … In this case, we're going to save the file … within our course workspace directory on the desktop. … I'm going to go ahead and name the file hsports-api.yaml. … Once the file has downloaded, we can navigate … to the directory containing the file … and we're going to copy our API definition. … From there, we're going to navigate … into the swagger-ui directory, … where we find the Swagger installation. … In this directory, you'll see the dist directory. … Let's navigate into that directory … and then paste our API definition file. … Now if we hop up a directory, … we can copy dist and then we can paste dist …
- The architecture of the Swagger ecosystem
- Using the tools within the Swagger platform
- Building a basic API using Swagger
- Defining APIs
- Creating API documentation using Swagger UI
- Creating and publishing APIs with SwaggerHub
- API management with Apigee
- Monitoring API usage
Skill Level Intermediate
HTTP Essential Trainingwith Morten Rand-Hendriksen50m 18s Beginner
1. Swagger Ecosystem
2. Building API Specifications
3. Creating and Publishing APIs with SwaggerHub
4. Capstone Project
Next steps1m 19s
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
This will not affect your course history, your reports, or your certificates of completion for this course.Cancel
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.
Notes are saved with you account but can also be exported as plain text, MS Word, PDF, Google Doc, or Evernote.