Learn API Technical Writing 2: REST for Writers

API Documentation 2: Teaches technical writers how to document REST. No programming experience required.
4.5 (168 ratings)
Instead of using a simple lifetime average, Udemy calculates a
course's star rating by considering a number of different factors
such as the number of ratings, the age of ratings, and the
likelihood of fraudulent ratings.
902 students enrolled
$19
$40
52% off
Take This Course
  • Lectures 20
  • Length 1.5 hours
  • Skill Level Intermediate Level
  • Languages English
  • Includes Lifetime access
    30 day money back guarantee!
    Available on iOS and Android
    Certificate of Completion
Wishlisted Wishlist

How taking a course works

Discover

Find online courses made by experts from around the world.

Learn

Take your courses with you and learn anywhere, anytime.

Master

Learn and practice real-world skills and achieve your goals.

About This Course

Published 6/2015 English

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 APIs
    • Break down REST requests into their various pieces with examples
    • Show real-time, narrated writing of REST documentation
    • Provide overviews of authentication and authorization for REST
  • 7 hands-on exercises to lead you through making and documenting REST requests
  • 7 short quizzes to keep you on your toes
  • PowerPoint presentations as a resource for every video lecture
  • A Microsoft Word document you can use as a template for REST reference material

The course takes approximately 3 hours and 30 minutes to complete, depending on how fast you are with the exercises.

What are the requirements?

  • Students should have either taken the Udemy course "Learn API Technical Writing: JSON and XML for Writers" or else be very familiar with how to document JSON and XML.
  • You will need a Word Processor (such as MS Word, Apple Pages, or Google docs). The Chrome browser is recommended for some of the exercises.

What am I going to get from this course?

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

What is the target audience?

  • 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.

What you get with this course?

Not for you? No problem.
30 day money back guarantee.

Forever yours.
Lifetime access.

Learn on the go.
Desktop, iOS and Android.

Get rewarded.
Certificate of completion.

Curriculum

Section 1: Introduction
05:07

This introduction explains:

  • What will be covered in the course
  • What APIs are
  • Why API documentation is important
07:34

This lecture covers what REST is. At the end, students should know:

  • REST is a type of web API
  • The difference between design patterns and protocols
  • How RESTful APIs use HTTP, requests, responses, and resources
  • How REST compares to SOAP
3 questions

Answer the following questions about REST.

Section 2: REST
04:37

This lecture covers how REST requests work. At the end, students should understand:

  • What a request is
  • The different parts to a request:
    • Method
    • URL
    • Query parameters
    • Headers
    • Body
4 questions

Identify part of a REST request

03:16

This lecture covers REST resources. At the end, students should understand:

  • What a resource is
  • How resources are represented in URLs
  • What endpoints are
  • How to specify either multiple or singular resources
  • How resources can contain other resources
3 questions

Choose the most likely resource for the given task.

04:33

This lecture covers HTTP methods. At the end, students should understand:

  • What a method is
  • What are CRUD operations
  • When the methods GET, POST, PUT, and DELETE are used
5 questions

Match up the actions with the most appropriate method.

4 pages

This exercise has you making REST calls to learn how to use the different HTTP methods.

1 page

This exercise teaches you how to document the method and the URL for a resource.

08:47

This lecture covers query parameters. At the end, students should understand:

  • What query parameters are
  • How they are used in REST
  • How to document them
Query Parameters
3 questions
Exercise 3 -- Make API requests with query parameters
2 pages
Exercise 4 -- Document query parameters
2 pages
04:28

This lecture covers headers. At the end, students should understand:

  • What headers are
  • How to use headers to specify formats
  • How to use headers for authorization
  • How to document headers
Headers
3 questions
Exercise 5 -- Document headers
1 page
12:46

Note: This lecture is technically the most difficult. If you are finding it hard to understand, don't get discouraged. Just skip it and come back to it at the end.

This lecture covers authentication and authorization. At the end, students should understand:

  • The difference between authentication and authorization
  • What app keys are
  • What OAuth is and a bit about how it works
  • Generally, how to document authentication and authorization
Authentication and Authorization
4 questions
06:00

This lecture covers request bodies, response bodies, and errors. At the end, students should understand:

  • Where is structured data used in REST?
  • What URLs in response data means
  • Sample requests and responses
  • How to document HTTP status codes
Exercise 6 -- Document status codes
1 page
Section 3: Putting It All Together
18:08

This lecture covers how to put all of the information from the course together to write reference API documentation. Two examples are documented in real time.

Exercise 7 -- Creating full reference documentation
3 pages
07:04

This lecture covers tools for documenting and calling REST APIs. At the end, students should understand:

  • How tools can help
  • The differences between single source tools, content management systems, and autogenerated documentation tools
  • What Markdown is
  • How to use a REST client to make REST API calls
04:56

This lecture is a review of the course, and includes:

  • A summary of each lecture
  • A description of next steps to writing complete REST API documentation
Bonus Lecture: Offer for Next Course in the Series
Article

Students Who Viewed This Course Also Viewed

  • Loading
  • Loading
  • Loading

Instructor Biography

Peter Gruenbaum, President, SDK Bridge

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.

Ready to start learning?
Take This Course