Learn API Technical Writing 2: REST for Writers (Udemy.com)

API Documentation 2: Teaches technical writers how to document REST. No programming experience required.

( 308 Reviews )

Created by: Peter Gruenbaum

Produced in 2021

What you will learn

Understand the basics of how REST works.
Understand the basics of authentication and authorization.
Create reference documentation for REST requests.

Quality Score

Content Quality

Video Quality

Qualified Instructor

Course Pace

Course Depth & Coverage

Overall Score : 94 / 100

Course Description

This is the second in a series of courses for technical writers who want to learn how to write API documentation. The first course is called "Learn API Technical Writing: JSON and XML for Writers", and it is recommended that you first take that course, unless you are very familiar with JSON and XML, and how to document them.
This course teaches how to document REST APIs. No programming experience is required, but technical writers with programming experience who want to know more about REST APIs will still find it useful.
What are APIs?
APIs (Application Program Interfaces) define how software systems talk to each other, and API documentation is a rapidly growing field. There is a strong need for writers who can understand APIs and explain them so that software developers can understand how to use them. API writers get to be in on the cutting edge of technology in high-paying positions.
What is REST?
REST (Representational State Transfer) is a popular style of web API, and it's used to communicate data between devices and servers. Different data is contained in different parts of the API requests and responses, and this course explains what those different parts are and how to document them.
What is in This Course?
By the end of the course, you will understand what REST is and how to read and document REST requests and responses. In this course you'll find:
12 videos that:
Provide background information on REST APIsBreak down REST requests into their various pieces with examplesShow real-time, narrated writing of REST documentationProvide overviews of authentication and authorization for REST7 hands-on exercises to lead you through making and documenting REST requests 7 short quizzes to keep you on your toesPowerPoint presentations as a resource for every video lectureA Microsoft Word document you can use as a template for REST reference materialThe course takes approximately 3 hours and 30 minutes to complete, depending on how fast you are with the exercises.
Who this course is for:
This course is designed for technical writers with experience writing end-user documentation and want to learn how to write API documentation. No prior programming or REST is required, but knowledge of JSON and XML is required.
This course is also helpful for technical writers with programming experience who want details on best practices for documenting REST.

Time: 1.5h

Instructor Details

Peter Gruenbaum

4.7 Rating
308 Reviews

Peter founded SDK Bridge to bring together his love of technology and writing. After 10 years as a software developer, he learned the skill of API writing at Microsoft. Since then, he has worked as an API writer to describe APIs for eCommerce, automobile traffic prediction, electric utilities, mobile phones, and tractors, just to name a few. In addition to API and SDK documentation, he creates video tutorials for software developer audiences. Peter received his BA in Physics from the University of Chicago and his PhD in Applied Physics from Stanford University.

Learn Swagger and the Open API Specification

Learn Swagger and the Open API Specification (2021)
4.3 (219 Reviews)

- Provider: Udemy
- Time: 1 hour on-demand videoh

$11.99

Coding for Writers: Basic Programming (2021)
4.6 (135 Reviews)

- Provider: Udemy
- Time: 2.5h

$11.99

The Art of API Documentation (2021)
4.3 (122 Reviews)

- Provider: Udemy
- Time: 1 hour on-demand videoh

$11.99

Git and GitHub for Writers (2021)
4.6 (46 Reviews)

- Provider: Udemy
- Time: 2.5h

$11.99

All courses by Peter Gruenbaum

More it & software courses

Kubernetes Certified Application Developer (CKAD) with Tests

Kubernetes Certified Application Developer (CKAD) with Tests (2021)
4.9 (312 Reviews)

- Provider: Udemy
- Time: 9.5h

$11.99

Angel Oracle Card Reader Course; Become the Oracle

Angel Oracle Card Reader Course; Become the Oracle (2021)
4.9 (288 Reviews)

- Provider: Udemy
- Time: 3.5h

$11.99

Cisco CCENT Packet Tracer Ultimate labs: ICND1 Exam prep lab

Cisco CCENT Packet Tracer Ultimate labs: ICND1 Exam prep lab (2021)
4.9 (121 Reviews)

- Provider: Udemy
- Time: 14h

$11.99

Microsoft Access Networking 2: Maximum Security

Microsoft Access Networking 2: Maximum Security (2021)
4.9 (68 Reviews)

- Provider: Udemy
- Time: 2.5h

$11.99

Oracle 12c Multitenant Architecture Administration

Oracle 12c Multitenant Architecture Administration (2021)
4.9 (53 Reviews)

- Provider: Udemy
- Time: 10.5h

$11.99

Certified Kubernetes Administrator (CKA) with Practice Tests

Certified Kubernetes Administrator (CKA) with Practice Tests (2021)
4.8 (312 Reviews)

- Provider: Udemy
- Time: 18h

$11.99

All it & software courses

Reviews

4.7

308 total reviews

5 star 4 star 3 star 2 star 1 star

Write a Review

By Antoniya Staneva on 11/8/2020

It was great, I learnt a lot of useful things.

By Ray Springer on 10/14/2020

Very good course. The structure (content, quiz, exercise) reinforces the information and allows you to put things together very quickly. Onward to more of Peter's courses.

By Durgesh Lingarkar on 9/22/2020

Amazing content and very nicely explained.

By Linda Bakker on 9/21/2020

Duidelijke uitleg, goede voorbeelden. Prima introducties en samenvattingen aan begin en eind van elk college.

By Cass Hall on 9/20/2020

I love Peter Gruenbaum's series of courses on JSON and API documentation. He gives such clear information and explanations. The pace is good and his exercises are very practical. I plan to take his entire series of classes.

By Anonymized User on 9/13/2020

very well explained

By Oscar Rivera on 9/9/2020

This is the second course created by Peter Gruenbaum that I completed. It took me more time than what I had anticipated but it paid off. I have a clearer notion of REST documentation. The next step is to try out some of the tools for REST documentation that are available.

By Rebecca McClelland on 9/6/2020

Helpful course. The instructor covered a lot of information without making it overwhelming. I appreciate the short quizzes after each section, as well as the Exercises to practice what I've learned. Thank you!

By Juan Jos Hernndez Oate on 8/27/2020