Deep Dive-Update A REST API Doc hands on-Ravi Desai

Cohort-based Course

This course is a deeper dive in TheContentGym newsletter edition: The REST API Story - Ravi's first day working on REST API Docs

Course overview

Develop a deeper understanding of what it takes to roll out REST API Doc updates

This course is a more detailed take on the example and video circulated on the edition 20 of The Content Gym newsletter on linkedin:


"The REST API Story - Ravi's first day working on REST API Docs"


While the original video and blog post helped you get started as a JIT measure, this course will give you a better understanding of what it entails, in general, to work with Git, Swagger, and a publishing tool for API reference docs such as Redocly.

This course also includes an ask-me-anything session with the instructor where you can clarify all your doubts on a zoom call.

Who is this course for

01

Technical writers who need to work on REST API updates as part of their work.

02

Technical Writers who want to start REST API Documentation and find a job as a Dev Docs Technical Writer where Git and Swagger are required.

What you’ll get out of this course

Better understanding of Git


Better understanding of working with the Swagger editor


What people are saying

        I attended an API session hosted by Gyanesh. The session was short but made a lasting impact in my memory. He not only gave overview of API but also shared some live examples on how API can be used to gather insights by taking data from social media. After this session, terms such as request-response were no more jargon for me. This session helped
Manank Gor

Manank Gor

Content Strategist - Mastercard
        I connected with Gyanesh regarding a video he created about technical writing for REST API. He is very knowledgeable on the topic and has a strong willingness to share that knowledge. He ability to explain complex topics succinctly is also very professional.
Peter Jurich

Peter Jurich

Technical Writer - Genentech

Meet your instructor

Gyanesh Talwar

Gyanesh Talwar

Gyanesh Talwar is a veteran in the Technical Writing space - with stints with Adobe and Oracle and experience of working across multiple continents on developer documentation, he is a passionate teacher who loves to simplify complex concepts. He manages the newsletter The Content Gym on linkedin where he creates learning content for REST APIs, Python/NLP, and what's new in the Technical Writing space.

A pattern of wavy dots

Be the first to know about upcoming cohorts

Deep Dive-Update A REST API Doc hands on-Ravi Desai

Course syllabus

01

Working with Git

  • Introduction to Git and GitHub
  • Cloning a repository
  • Creating a branch
  • Making changes to the code
  • Committing changes
  • Pushing changes to the remote repository
  • Merging changes from a branch


02

Swagger Editor Deep Dive

  • Introduction to Swagger
  • Creating a Swagger definition file
  • Documenting REST API endpoints and parameters
  • Using Swagger to generate documentation
  • Debugging Swagger definitions


03

Hosting API Reference

  • Overview of API hosting options
  • Pros and cons of each option
  • Choosing the right API hosting option for your needs
  • Setting up an API hosting service
  • Managing your API documentation


04

Writing Clear and Concise API Documentation


  • Tips for writing clear and concise API documentation
  • Using code examples to illustrate API usage
  • Testing API documentation


Course schedule

2 hours

  • Self paced


  • Personal interaction with the instructor

Learning is better with cohorts

Learning is better with cohorts

Active hands-on learning

This course builds on live workshops and hands-on projects

Interactive and project-based

You’ll be interacting with other learners through breakout rooms and project teams

Learn with a cohort of peers

Join a community of like-minded people who want to learn and grow alongside you

Frequently Asked Questions

A pattern of wavy dots

Be the first to know about upcoming cohorts

Deep Dive-Update A REST API Doc hands on-Ravi Desai

Add a featured image or video here

Add a featured image or video here