Swagger API Documentation

  • Course level: All Levels


Swagger API Documentation

This is the third in a series of courses for technical writers who want to learn how to write API documentation. The first two courses are called “Learn API Technical Writing: JSON and XML for Writers” and “Learn API Technical Writing: REST for Writers”, and it’s recommended that you first take those courses unless you are very familiar with API documentation, and how to document reference material.

This course teaches how to write conceptual Swagger API Documentation, such as overviews, getting started sections, and tutorials. For the most part, no programming experience is required, but technical writers with programming experience will still find it useful.

In addition to conceptual material, this course covers guidelines for good sample code, tools for making REST requests, and how to find an open-source project to document as a way to get into the field of API writing.

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 to 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.

Who this Swagger API Documentation course is for:

  1. This course is designed for technical writers who have some understanding of how to write API reference material.
  2. No programming knowledge is required.
  3. Take the first two courses in the series if you need a stronger understanding of APIs.
  4. This course does not cover how to document reference material (requests, responses, classes, members, etc.)

What Will I Learn?

  • Write API conceptual documentation, such as overviews, getting started sections, and tutorials.
  • Make calls to REST APIs using visual and command-line tools.
  • Find an open source project to document as a way of gaining experience.

Topics for this course

8 Lessons

Swagger API

1 – Intro to API documentation with Swagger00:00:00
2 – How to use swagger online editor00:00:00
3 – YAML tutorial00:00:00
4 – Open API specification summary00:00:00
5 – how to install and setup swagger locally00:00:00
6 – How to setup swagger UI dist00:00:00
7 – gulp task automation00:00:00
8 – crash course and summary00:00:00
Swagger API Documentation
27 £

Enrolment validity: Lifetime


  • You should be familiar with APIs and how to document requests and responses (for web APIs) and classes and members (for platform APIs).