By Nicky Bleiel and Cindy Currie | 2019 Summit Conference Co-Chairs

If you need to document a REST API, this workshop at the STC Summit is for you!

Join Tom Johnson for a full day workshop on API Documentation on Sunday, 5 May at the 2019 STC Technical Communication Summit & Expo in Denver, Colorado.

In this workshop, you’ll learn about API documentation in the context of using a simple weather API — making requests and analyzing the responses. We’ll cover the essential elements of API reference topics (such as endpoints, parameters, and response schemas), how OpenAPI specification and Swagger work (as well as tools to simplify spec development), expected non-reference topics (such as authorization and rate limiting), version control workflows (in Git and GitHub), and more. If you’re starting to document a REST API, this workshop will get you up and running in the right direction. You’ll leave with a solid grasp of the necessary components of REST API documentation as well as how to deliver an interactive learning experience that developers want.

Takeaways:

– REST APIs involve requests and responses, not too unlike visiting a Web page—you make a request to a resource stored on a server, and the server responds with the requested information.
– Web API reference topics have essential sections: resource descriptions, endpoints and methods, parameters, request examples, and response examples and schemas.
– The OpenAPI specification provides a standard structure for describing your REST API; Swagger UI can consume the OpenAPI spec to provide interactive documentation.

For more information see Preconference Workshops.

Full workshop description here.

0

Consider reading these posts.

STC Announces Most Improved Community and Community of the Year Awards
Aiessa Moyna Wins 2019 STC President’s Award
Peter Morville Named STC’s 2019 Honorary Fellow

Leave a Reply