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?
Read more
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?
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.
Here's a deal for you
UDEAFNULP2024
What's inside
Learning objectives
- Understand the basics of how rest works.
- Understand the basics of authentication and authorization.
- Create reference documentation for rest requests.
- Understand the basics of how rest works.
- Understand the basics of authentication and authorization.
- Create reference documentation for rest requests.
Syllabus
Students will understand what is covered in this course and what REST is.
This introduction explains:
- What will be covered in the course
- What APIs are
- Why API documentation is important
Read more
Syllabus
This introduction explains:
- What will be covered in the course
- What APIs are
- Why API documentation is important
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
Answer the following questions about REST.
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
Identify part of a REST request
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
Short note on resource names
Choose the most likely resource for the given task.
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
Match up the actions with the most appropriate method.
This exercise has you making REST calls to learn how to use the different HTTP methods.
This exercise teaches you how to document the method and the URL for a resource.
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
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
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
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
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.
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
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
Good to know
Save this course
Save
Activities
Review REST basics
Show steps
Review the basics of REST to ensure a strong foundation for this course.
Browse courses on
REST
Show steps
-
Review the course syllabus and identify key REST concepts.
-
Read online articles and tutorials on REST principles and methods.
-
Complete hands-on exercises or simulations to practice using REST APIs.
Review the book "RESTful Web Services Cookbook"
Show steps
Gain insights and practical guidance on RESTful web services through this recommended book.
View
RESTful Web APIs
on Amazon
Show steps
-
Purchase or borrow a copy of "RESTful Web Services Cookbook".
-
Read through relevant sections on REST API design, documentation, and best practices.
-
Apply the concepts you learn to your own REST API documentation projects.
Practice Making RESTful API Calls
Show steps
Reinforces the concepts of making RESTful API calls and working with request and response structures.
Show steps
-
Use an API testing tool like Postman to make GET, POST, PUT, and DELETE requests to a RESTful API.
-
Inspect the HTTP headers and bodies of the requests and responses to understand their structure and content.
-
Practice sending requests with different parameters and payloads to observe the effects on the responses.
Two other activities
Expand to see all activities and additional details
Show all five activities
Write a Blog Post on RESTful API Design
Show steps
Provides an opportunity to synthesize and communicate understanding of RESTful API design principles.
Browse courses on
Technical Writing
Show steps
-
Choose a specific aspect of RESTful API design to focus on, such as resource naming or error handling.
-
Research and gather information on the topic.
-
Write a blog post that explains the topic clearly and concisely.
Contribute to an Open Source RESTful API Project
Show steps
Provides hands-on experience in applying RESTful API design principles and working on real-world projects.
Browse courses on
API Development
Show steps
-
Find an open source RESTful API project on platforms like GitHub.
-
Review the project documentation and identify an area where you can contribute.
-
Submit a pull request with your proposed changes or additions.
Review REST basics
Show steps
Review the basics of REST to ensure a strong foundation for this course.
Browse courses on
REST
Show steps
- Review the course syllabus and identify key REST concepts.
- Read online articles and tutorials on REST principles and methods.
- Complete hands-on exercises or simulations to practice using REST APIs.
Review the book "RESTful Web Services Cookbook"
Show steps
Gain insights and practical guidance on RESTful web services through this recommended book.
View
RESTful Web APIs
on Amazon
Show steps
- Purchase or borrow a copy of "RESTful Web Services Cookbook".
- Read through relevant sections on REST API design, documentation, and best practices.
- Apply the concepts you learn to your own REST API documentation projects.
Practice Making RESTful API Calls
Show steps
Reinforces the concepts of making RESTful API calls and working with request and response structures.
Show steps
- Use an API testing tool like Postman to make GET, POST, PUT, and DELETE requests to a RESTful API.
- Inspect the HTTP headers and bodies of the requests and responses to understand their structure and content.
- Practice sending requests with different parameters and payloads to observe the effects on the responses.
Write a Blog Post on RESTful API Design
Show steps
Provides an opportunity to synthesize and communicate understanding of RESTful API design principles.
Browse courses on
Technical Writing
Show steps
- Choose a specific aspect of RESTful API design to focus on, such as resource naming or error handling.
- Research and gather information on the topic.
- Write a blog post that explains the topic clearly and concisely.
Contribute to an Open Source RESTful API Project
Show steps
Provides hands-on experience in applying RESTful API design principles and working on real-world projects.
Browse courses on
API Development
Show steps
- Find an open source RESTful API project on platforms like GitHub.
- Review the project documentation and identify an area where you can contribute.
- Submit a pull request with your proposed changes or additions.
Career center
Reading list
Share
Similar courses
OpenCourser helps millions of learners each year. People visit us to learn workspace skills, ace their exams, and nurture their curiosity.
Our extensive catalog contains over 50,000 courses and twice as many books. Browse by search, by topic, or even by career interests. We'll match you to the right resources quickly.
Find this site helpful? Tell a friend about us.
We're supported by our community of learners. When you purchase or subscribe to courses and programs or purchase books, we may earn a commission from our partners.
Your purchases help us maintain our catalog and keep our servers humming without ads.
Thank you for supporting OpenCourser.
