API Documentation
Document APIs with OpenAPI so others can use them without asking you.
What you'll learn
- Write an OpenAPI 3 specification
- Describe schemas, parameters and errors
- Publish interactive docs
- Write a getting-started guide
About this course
You write an OpenAPI spec for an existing API, generate interactive docs and add examples. You also write a getting-started guide.
Course curriculum
4 modules and 12 lessons over 4 weeks. Plan for about 12 learning hours.
01OpenAPI basicsWeek 1 · 3 lessons
- Structure
- Paths and operations
- Schemas
02DetailsWeek 2 · 3 lessons
- Parameters
- Auth
- Error responses
03PublishingWeek 3 · 3 lessons
- Swagger UI
- Redoc
- Examples
04GuideWeek 4 · 3 lessons
- Getting started
- Authentication guide
- Changelog
Project
Documented API. An OpenAPI spec, interactive docs and a getting-started guide for a sample API.
Who this course is for
Developers who build APIs for other people.
Prerequisites
You have built a REST API.
What's included
- 180-day course access
- Project brief
- Starter repository
- Coding labs
- Reference solutions
- One written project review
- A digital completion certificate
Learning format
Project-based online course, part of our guided project courses. One written project review.
Access and delivery
- Course access is delivered within 15 minutes after payment.
- Written project review is returned within 2 business days of submission.
- Completion materials are issued within 2 business days after the project is approved.
Certificate
You receive a digital completion certificate. Completion materials are issued within 2 business days after the project is approved.
Frequently asked questions
When does access start?
Course access is delivered within 15 minutes after payment.
Is payment taken on this website?
No. After you submit your enrollment request, we reply by email with payment details and enrollment confirmation.
Does this course guarantee a job or income?
No. It is an education and training service and does not include employment, income or placement guarantees.
Can I cancel?
Our Refund and Cancellation Policy lists the terms for project-based programs.
