Udemy
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
Development
Web Development Data Science Mobile Development Programming Languages Game Development Database Design & Development Software Testing Software Engineering Development Tools No-Code Development
Business
Entrepreneurship Communications Management Sales Business Strategy Operations Project Management Business Law Business Analytics & Intelligence Human Resources Industry E-Commerce Media Real Estate Other Business
Finance & Accounting
Accounting & Bookkeeping Compliance Cryptocurrency & Blockchain Economics Finance Finance Cert & Exam Prep Financial Modeling & Analysis Investing & Trading Money Management Tools Taxes Other Finance & Accounting
IT & Software
IT Certification Network & Security Hardware Operating Systems Other IT & Software
Office Productivity
Microsoft Apple Google SAP Oracle Other Office Productivity
Personal Development
Personal Transformation Personal Productivity Leadership Career Development Parenting & Relationships Happiness Esoteric Practices Religion & Spirituality Personal Brand Building Creativity Influence Self Esteem & Confidence Stress Management Memory & Study Skills Motivation Other Personal Development
Design
Web Design Graphic Design & Illustration Design Tools User Experience Design Game Design Design Thinking 3D & Animation Fashion Design Architectural Design Interior Design Other Design
Marketing
Digital Marketing Search Engine Optimization Social Media Marketing Branding Marketing Fundamentals Marketing Analytics & Automation Public Relations Advertising Video & Mobile Marketing Content Marketing Growth Hacking Affiliate Marketing Product Marketing Other Marketing
Lifestyle
Arts & Crafts Beauty & Makeup Esoteric Practices Food & Beverage Gaming Home Improvement Pet Care & Training Travel Other Lifestyle
Photography & Video
Digital Photography Photography Portrait Photography Photography Tools Commercial Photography Video Design Other Photography & Video
Health & Fitness
Fitness General Health Sports Nutrition Yoga Mental Health Dieting Self Defense Safety & First Aid Dance Meditation Other Health & Fitness
Music
Instruments Music Production Music Fundamentals Vocal Music Techniques Music Software Other Music
Teaching & Academics
Engineering Humanities Math Science Online Education Social Science Language Teacher Training Test Prep Other Teaching & Academics
AWS Certification Microsoft Certification AWS Certified Solutions Architect - Associate AWS Certified Cloud Practitioner CompTIA A+ Cisco CCNA Amazon AWS CompTIA Security+ AWS Certified Developer - Associate
Graphic Design Photoshop Adobe Illustrator Drawing Digital Painting InDesign Character Design Canva Figure Drawing
Life Coach Training Neuro-Linguistic Programming Personal Development Mindfulness Personal Transformation Meditation Life Purpose Coaching Neuroscience
Web Development JavaScript React CSS Angular PHP WordPress Node.Js Python
Google Flutter Android Development iOS Development Swift React Native Dart Programming Language Mobile Development Kotlin SwiftUI
Digital Marketing Google Ads (Adwords) Social Media Marketing Google Ads (AdWords) Certification Marketing Strategy Internet Marketing YouTube Marketing Email Marketing Retargeting
SQL Microsoft Power BI Tableau Business Analysis Business Intelligence MySQL Data Analysis Data Modeling Big Data
Business Fundamentals Entrepreneurship Fundamentals Business Strategy Online Business Business Plan Startup Freelancing Blogging Home Business
Unity Game Development Fundamentals Unreal Engine C# 3D Game Development C++ 2D Game Development Unreal Engine Blueprints Blender
30-Day Money-Back Guarantee

This course includes:

  • 1.5 hours on-demand video
  • 2 articles
  • 22 downloadable resources
  • Full lifetime access
  • Access on mobile and TV
IT & Software Other IT & Software Technical Writing

Learn API Technical Writing 2: REST for Writers

API Documentation 2: Teaches technical writers how to document REST. No programming experience required.
Rating: 4.6 out of 54.6 (1,595 ratings)
7,031 students
Created by Peter Gruenbaum
Last updated 11/2020
English
English
30-Day Money-Back Guarantee

What you'll learn

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

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.

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.

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.

Featured review

Steve Garriott
Steve Garriott
10 courses
6 reviews
Rating: 5.0 out of 5a year ago
This course came along just in time as I was given the task of writing up API docs. I'm still figuring out the best way to document the current batch of requests, but this course has given me the background info I needed to at least look like I knew what I was doing while I was learning to do it :)

Course content

3 sections • 21 lectures • 1h 45m total length

  • Preview05:07
  • Preview07:34
  • REST
    3 questions

  • Requests
    04:37
  • REST requests
    4 questions
  • Resources
    03:16
  • Plural resource names
    00:37
  • Resources
    3 questions
  • Methods
    04:33
  • Methods
    5 questions
  • Exercise 1 -- Making REST requests
    5 pages
  • Exercise 2 -- Document method and resource URL
    2 pages
  • Query Parameters
    08:47
  • Query Parameters
    3 questions
  • Exercise 3 -- Make API requests with query parameters
    3 pages
  • Exercise 4 -- Document query parameters
    2 pages
  • Headers
    04:28
  • Headers
    3 questions
  • Exercise 5 -- Document headers
    1 page
  • Authentication and Authorization
    12:46
  • Authentication and Authorization
    4 questions
  • Request Bodies and Responses
    06:00
  • Exercise 6 -- Document status codes
    1 page

  • Putting It All Together
    18:08
  • Exercise 7 -- Creating full reference documentation
    3 pages
  • Tools for REST Documentation
    07:04
  • Review and Next Steps
    04:56
  • Bonus Lecture: Offer for Next Course in the Series
    00:36

Instructor

Peter Gruenbaum
President, SDK Bridge
Peter Gruenbaum
  • 4.5 Instructor Rating
  • 8,964 Reviews
  • 29,723 Students
  • 6 Courses

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. 

  • Udemy for Business
  • Teach on Udemy
  • Get the app
  • About us
  • Contact us
  • Careers
  • Blog
  • Help and Support
  • Affiliate
  • Terms
  • Privacy policy
  • Cookie settings
  • Sitemap
  • Featured courses
Udemy
© 2021 Udemy, Inc.