About this course

No understanding of code, no challenge. Join our Fundamentals of API documentation course to start your career as API documentation writer.

Details for Batch 12

• Registration is open. Scroll down below to view how to register and see course details.
• Dates of 6 sessions: June 4-5, 11-12, 18-19
• Timing: 10.30 AM – 12.30 PM IST all days

Key Highlights

• Understand and write code
• Prepare API documentation based on global templates
• Learn Postman and Swagger

Overview

The course is designed for all who are not aware about APIs or coding and want to start working as API documentation writer.

The course is spread over three weekends that includes:

• Total 12 hours of Online classes – 2 hours each on 6 days (Saturdays and Sundays)
• 21 days of offline interaction after the sessions in a separate Telegram group for students

View Testimonials

• 200+ Tech Writers from different parts of India and World got benefitted so far.
• Some of the students have already started working as API documentation writer now.

Who can join!

Anyone who wants to excel in documenting APIs, understand basics of REST APIs, and practice on-the-spot using API development tools.

No prior experience in API documentation is required.

How to Register

Fee

As per the government, GST of 18% is applicable on all payments.

• Full Fee: INR 4900 (INR 5800 with GST)
• Group of 3: INR 4600 each (INR 5500 each with GST)

Pay and register

• • Option 1: Use QR Code (Indian banks only) and save processing charge. Click to Register.
  • Option 2: Use other payment methods (Indian Banks only):
    Individual Fee: INR 5800

   

  • For Group of 3: INR 16,500 (INR 5500 each)

• Option 3: For International Payments (Banks outside India). CLICK TO MAKE PAYMENT AND REGISTER

Course Curriculum

Day 1

What is API? ​

​Understanding​

•  Web services ​
•  HTTP & HTTPS​
•  Microservices ​
•  Webhooks ​
•  SOAP and REST APIs

Day 2

Introduction to ​

• JSON​
• YAML
• Learning how to write code in JSON

Day 3

REST APIs (POSTMAN)​

• Authorization & Authentication​
• Requests ​
• Resources ​
• Methods ​
• Query Parameters​
• Responses 
• Creating API document

Day 4

REST APIs (Swagger)​

• Understanding OpenAPI Specs
• Testing APIs ​
• Creating API document

Day 5

API documentation ​

• Structure of an API document​
• Grammar and sentence construction​
• Best practices
• Tips and Tricks

Day 6

• How your API doc website should look like ​
• Revision
• Assessments 

Takeaway from Course

Learn the basic of API concepts and how to document, get ready to face interviews related to APIs and start career as API document writer.

Requirements for participants

• Must have a Desktop/Laptop to work on exercises during the session.
• Must have POSTMAN downloaded to use for practice during the session.
• Must have access to Microsoft Teams from Laptop.

Meet the Trainer

Pallavi Deshpande is an accomplished Technical Writer with overall 15+ years of experience. Having helped organisations shape their Developer documentation strategy, she holds specialisation in production documentation also. Apart from product and API documentation, she loves to play around Docs-as-code using Hugo.

View Testimonials