Learn OpenAPI Specification with VS Code

Focused View

Weesho Lapara

53:48

156 View

1 - Introduction

1 - Introduction to Web API.mp4

04:18

2 - Introduction to the components of Web API URL.mp4

03:42

3 - Anatomy of API Calls with Introduction to Authentication and Authorization.mp4

08:04

4 - A quick overview of HTTP request methods.mp4

04:37

2 - Setting yourself up for API documentation using OpenAPI specification

5 - An overview of the required setup.mp4

05:05

6 - A Demo of the setup.mp4

04:55

6 - download vs code.zip

6 - github repository.zip

6 - how to setup localhost in windows 10.zip

6 - introduction to json.zip

6 - introduction to yaml.zip

6 - rapidoc vanilla html code.zip

3 - Documenting a simple API Reference using Open API Specification

7 - A demo.mp4

23:07

7 - git tutorial.zip

7 - openapi documentation.zip

Description

Quick and easy steps to get started with Open API Specification

What You'll Learn?

Learn the basics of API reference documentation
Estimate what you need before you start documenting API reference using OpenAPI specification
Learn how to setup Visual Studio Code with proper extension for OpenAPI specification
Watch a demonstration of a simple API reference documentation based on OpenAPI specification

Who is this for?

Beginner and Intermediate Technical Writers

What You Need to Know?

JSON, YML, VS Code, GitHub

More details

Description
OpenAPI specification has been a buzzword for many years for those wanting to get into documenting API references. However, many of us have been unable to find the right resources that are able to point us in the right direction. What are the current industry standards? What are the tools to use? How do I get started? All these questions were left unanswered until now!

If you are curious to learn more about the world of OpenAPI and get familiar with the tools used for API reference documentation, this might be the right course for you. We will start with the basics and then move on to more advanced topics. Finally, we will finish this course with a working sample of API references based on Open API specifications.

This course takes you through the very basics of Web API, helps you set up with the right tools and resources, and get you started documenting Rest API reference using all the industry-standard tools. Through this course, you will:

1) Know the stakeholders that will become a part of your documentation initiative
2) Be able to set up a documentation test server locally
3) Be able to choose the tools necessary to start API documentation
4) Get familiar with the basics of Open API specification
Who this course is for:
Beginner and Intermediate Technical Writers

User Reviews

Rating

average 0

Total votes0

Focused display

Weesho Lapara is a technical writing agency based in Sydney, Australia. We specialize in creating technical communications materials ranging from user manuals to SDK documentation. We also help organizations to setup the tools and resources required to build their developer portal. For a range of services that we offer, see our website.

Udemy

View courses Udemy

Students take courses primarily to improve job-related skills.Some courses generate credit toward technical certification. Udemy has made a special effort to attract corporate trainers seeking to create coursework for employees of their company.