Versions Compared
| Version | Old Version 5 | New Version Current |
|---|---|---|
| Changes made by | ||
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Course Information
- Course Title: Navigating Swagger UI
- Course Code: 2511
- Tracks: Technical Track
- Series: Advanced Ed-Fi Topics (200 Series)
- Course Prerequisites:
- Learning Delivery Mode: Self-Guided Course (Online)
- Text
- Registration Options: Online
- Link to online course
Course Overview
Description
Swagger UI is the interactive documentation of the Ed-Fi API. It can be used to understand the various API resources behind an Ed-Fi ODS/API Platform deployment and the patterns seen across the various resources. Using the Ed-Fi Alliance's Alliance’s public Swagger UI documentation, this course will show you the essentials so that you can confidently navigate Swagger UI yourself.
Who Should Enroll
- Anyone who interfaces with the Ed-Fi API. This could be a technical user who needs to make API calls or a non-technical user who is creating a data mapping to the Ed-Fi API.
Course Outcome
By the end of this course, Academy students will be able to:
- Navigate and interact with a Swagger UI deployment.
Learning Objectives
The learning objectives for this course are:
- Understand the structure of Swagger UI documentation to quickly answer questions related to the Ed-Fi API that may arise.
- Understand the various HTTP-verbs behind an API resource and know when to use which for what.
- Understand how the Ed-Fi API's API’s id and natural key feature is surfaced in Swagger UI documentation.
Course Modules
- TBD