This month, Tanya Perelmuter will provide an overview of RESTful APIs and discuss how to document them with Swagger / Open API Specification.
In the first part of the presentation, Tanya will explain differences between RESTful APIs and other types of APIs (e.g. SOAP APIs), discuss main concepts of RESTful APIs and REST architecture, and specify minimum necessary information to be provided about REST API endpoints in reference documentation.
In the second part of the presentation, Tanya will talk about Open API Specification and Swagger toolkit for designing and documenting RESTful APIs. She will present main elements of API description in Open API Specification, demonstrate Swagger tools and SwaggerHub platform, discuss Swagger strengths and weaknesses, and talk about alternatives to Swagger and Open API Specification.
About Tanya Perelmuter
Tanya Perelmuter has a B.S. degree in Mathematics and Computer Sciences from Tel Aviv University, Israel. She spent first two decades of her career working as a software engineer and systems analyst, mostly in Telecom, Healthcare, and eCommerce domains. Then she decided to pursue her love for writing high quality technical documentation and leverage her experience in writing software requirements specs and software design documents to steer her career in technical writing direction.
For the last three years Tanya has worked as a technical writer, specializing mostly in developer documentation, such as software functional specs, API references, and developer guides. She is currently pursuing a Technical Communication Certificate at UC San Diego Extension. Her passions in the technical writing field include API documentation and structured authoring.
Presentation time: 7:00-8:00pm+
Location: IHOP Restaurant, 4200 Great America Parkway, Santa Clara, CA 95054
Event Report and Slides
I’m happy to report that our June 2018 meeting was very well attended. By popular request, the slide deck for “Understanding RESTful APIs and Documenting Them with Swagger” can now be found at the link below. It serves as a stand-alone primer for introducing concepts of RESTful APIs, flush with documentation examples and links to further resources.
Take care and happy learning!