This course was created with the
course builder. Create your online course today.
Start now
Create your course
with
Autoplay
Autocomplete
Previous Lesson
Complete and Continue
Getting Started with API Documentation
Getting Started with API Documentation
Introduction (1:48)
What will you learn? (2:38)
What is an API? (2:57)
Benefits from using an API (3:11)
How does an API work? (3:14)
Who creates API and API documentation? (4:00)
What is an API documentation? (4:50)
Types of APIs (1:34)
Who reads API documentation? (2:49)
API documentation - examples (17:47)
API documentation framework (0:31)
API documentation - structure (1:04)
Step 1 (0:22)
Step 2 (1:10)
Step 3 (0:31)
Testing an API call (3:02)
Writing API Documentation Using Swagger
Writing API documentation using Swagger UI (0:20)
Agenda (1:02)
What is Swagger? (0:52)
Benefits from using Swagger for writing API documentation (3:47)
Step 1: create new API (1:29)
Demo (2:50)
Step 2: create the API introductory page (0:56)
Step 2.1: edit the API info (0:55)
Sample introductory info (0:20)
Demo (3:20)
Step 2.2: edit the API contacts and links to further documentation (5:58)
Sample contacts and documentation link (0:56)
Step 3: define the tags of your API (5:30)
Step 4: define the API operations and paths (3:50)
Sample API operation and path (0:40)
Demo (1:34)
Step 5: document the API parameters (1:14)
Sample parameters (3:35)
Step 6: document the API responses (0:34)
Sample response (1:55)
Step 7: export the API documentation (1:59)
Writing API Documentation Using Postman and GitHub Wiki Pages
Section introduction (5:32)
What will you learn in this section? (1:00)
Tools we will use (1:40)
What's the story? (2:02)
What is Postman? (1:18)
Downloading and getting to know Postman (4:03)
Using Postman, document the usage of the Stripe API (2:03)
Step 1 (5:08)
Step 2 - part 1 (4:27)
Step 2 - part 2 (0:41)
Step 3 (3:13)
Step 4 (8:27)
Step 5 (33:54)
What is an API documentation?
Lesson content locked
If you're already enrolled,
you'll need to login
.
Enroll in Course to Unlock