Course Essentials
Mode: Online, live sessions
Duration: 8 Saturdays or Sundays, 1.5 hours each session + Homework assignments
Certification: Based on attendance and performance
Mastering API Documentation
Master the art of creating comprehensive, developer-friendly API documentation that enhances user experience and facilitates smooth onboarding processes.
- Discuss and document modern APIs with authority
- Have a robust process for documenting any REST API
- Understand how developers use APIs to build applications
- Be able to document API flows and write comprehensive user guides
- Be able to set up tools and environments for testing and documenting APIs
- Learn Docs-as-Code tools and workflows
The course commences by establishing a solid understanding of APIs, progressing into a comprehensive exploration of OpenAPI. It then outlines a meticulous process for documenting APIs, encompassing the gathering of source material from development artifacts, strategic documentation planning, crafting API references, creating user-friendly "get started" guides, and detailing functionalities and implementation recipes.
Training: Before the course, the trainer will provide instructions for setting up the needed software and repositories.
Work experience: No specific work experience required
Hardware and software
Docker Desktop
Postman
Postman agent
Visual Studio Code
You need to clone the course GitHub repo and run the Docker containers
You need a computer that can download software (i.e., some work computers do not allow this) and meets the requirements to run Docker desktop
How you are evaluated
- Submit the final documentation project created during the course and have it peer reviewed and incorporate any corrections
- Pass a test at the end that covers the different topics of the course
You will receive a Certificate of Completion from STC India based on the following criteria
- 80% attendance
- 70% score on final exam
- Submitted their final documentation project for review