Using REST APIs - workshop for technical writers

Application Programming Interface (API) enables communication between applications. The ability to use APIs is useful for anyone documenting software, and especially for those creating content for developers. Testing a product in practice is the best way to verify whether the design and specification align with the implementation.

During the workshop you will learn:

• What types of requests exist in REST APIs, how to send them to an API, and how to read responses
• How to use an HTTP client
• How to authenticate
• How to use headers
• How to write a simple script in JavaScript that will send a request, read the response, and then process it

The workshop is focused on learning by doing, so participants spend most of their time on practical tasks, accompanied by theory to the extent that allows proper understanding of the steps being performed.