+48 570 570 393
You are here: Home » Services » Trainings and Workshops » REST API Documentation

REST API Documentation

  • iconLength: 2 days
  • iconFormat: In-class
  • iconInstructor: Marcin Pierzchała
  • iconLanguages: PL/EN
This day-long course offers a comprehensive overview of the tools and methods used in documenting REST APIs. We discuss the complete lifecycle of API documentation, from high-level design, through creating and sourcing content, to publication and delivery. The participants are shown good and bad practices, learn how to use the dedicated tools, and gain some hands-on experience through practical exercises. The main focus is placed on understanding the OpenAPI specification and leveraging Swagger tools.

This course teaches the participants how to approach the task of documenting a REST API. Through concrete examples, they learn about core concepts in and constitutive parts of API documentation. We also explore some theoretical principles of technical communication as we go, and demonstrate how they can be applied to documenting REST APIs. At the end of the course, the participants should have a good understanding of what constitutes good API documentation and how to use industry standards (OpenAPI) and tools (Swagger) to achieve their goal.

  1. Introduction to API Documentation
    • Objective and Audience
    • What Makes for Great API Documentation?
    • Types of Content
    • Documentation Workflow
  2. Documenting REST APIs
    • Creating Reference Documentation
    • Creating Conceptual Documentation
  3. OpenAPI and Swagger
    • Introduction to OpenAPI
    • Swagger and Other API Documentation Tools
    • Writing an OpenAPI Specification
    • Workshop Activity
  4. Delivering API Documentation
    • Static-Site Generators
    • Combining Reference and Conceptual Content
Software Developers, tech-savvy Technical Writers and User Assistance Specialists. Although designed with programmers in mind, this course can be tailored to fit the needs of a less technical audience.
Date Place Instructor Languages Price
17-01-2019, 09:00 AM Cracow Marcin Pierzchała PL/EN 2500.00 PLN BUY
ul. Grzegórzecka 85/13
31-559 Cracow
Phone: +48 570 570 393
E-mail: office@dredar.com