Getting Started with API Documentation
A framework for writing documentation about APIs as a technical writer
Watch Promo
Are you a technical writer who must write API software documentation? Do you wonder what you need to prepare and deliver to have high-quality API documentation and do not know where to start?
If yes, then this course is for you!
At JPDocu School of Technical Writing, we believe that technical writing is and should stay a simple task. Simple like in "easy to do"! That's why we do our best to explain API and API documentation in simple terms, making it simple and easy for you to follow!
API stands for Application Programming Interface. An interface is a software abstraction, which allows two software applications to communicate with each other seamlessly.
There are two roles you need to consider when you write documentation about an API:
- The role of the developer who created the API. This developer needs to provide information about the way the API is supposed to work; what requests can it receive and what responses does is provide.
- The role of the developer who uses the API. This developer needs to read through the API documentation to understand the ways to connect to the API, the requests that he or she can send to the API, and the responses that the API shall return for these requests.
In this course, you will learn:
- What is API and API documentation - explained in a way so that you can understand. No special programming knowledge is required!
- Which are the steps you need to follow to prepare and provide documentation about your API - a small framework to make sure you have steps to follow while preparing the API documentation.
- How to use Swagger UI to write and generate API documentation automatically.
- How to use Postman to check the functionality provided with an API, and
- How to put it all together on a GitHub wiki page!
Try it now, and see how easy it is to write API documentation, once you know which are the basic steps to follow!
Your Instructor
Using the principles he teaches, Jordan Stanchev has built his career in the field of technical communications.
He applies practical experience collected through years of work in the IT industry as a Java developer, DITA XML technical writer, knowledge architect, project management professional (PMP), and user assistance development architect.
Jordan Stanchev is one of the founders of TEKOM Bulgaria, a passionate teacher at the University, and a User Assistance Development Architect at a Fortune 100 company.
Jordan is the author of various courses related to the field of technical communications, ranging from the basics of technical writing to DITA information architecture, taxonomies, and metadata.
Jordan Stanchev is a frequent speaker and presenter at technical communications conferences, such as tcworld - Stuttgart, Germany, and ETC - Sofia, Bulgaria.
His vast practical experience in technical communications allows his audience to experience a practitioner with real-life experience and advanced knowledge in the field.
Jordan Stanchev believes that we all can achieve so much more at our job with practice and hard work!
Over 20000 participants from around the world have attended Jordan Stanchev’s seminars. His courses change people's professional lives for the better!
Course Curriculum
Getting Started with API Documentation
Available in
days
days
after you enroll
-
PreviewIntroduction (1:48)
-
PreviewWhat will you learn? (2:38)
-
PreviewWhat is an API? (2:57)
-
PreviewBenefits from using an API (3:11)
-
PreviewHow does an API work? (3:14)
-
PreviewWho creates API and API documentation? (4:00)
-
StartWhat is an API documentation? (4:50)
-
StartTypes of APIs (1:34)
-
StartWho reads API documentation? (2:49)
-
StartAPI documentation - examples (17:47)
-
StartAPI documentation framework (0:31)
-
StartAPI documentation - structure (1:04)
-
StartStep 1 (0:22)
-
StartStep 2 (1:10)
-
StartStep 3 (0:31)
-
StartTesting an API call (3:02)
Writing API Documentation Using Swagger
Available in
days
days
after you enroll
-
PreviewWriting API documentation using Swagger UI (0:20)
-
PreviewAgenda (1:02)
-
PreviewWhat is Swagger? (0:52)
-
StartBenefits from using Swagger for writing API documentation (3:47)
-
StartStep 1: create new API (1:29)
-
StartDemo (2:50)
-
StartStep 2: create the API introductory page (0:56)
-
StartStep 2.1: edit the API info (0:55)
-
StartSample introductory info (0:20)
-
StartDemo (3:20)
-
StartStep 2.2: edit the API contacts and links to further documentation (5:58)
-
StartSample contacts and documentation link (0:56)
-
StartStep 3: define the tags of your API (5:30)
-
StartStep 4: define the API operations and paths (3:50)
-
StartSample API operation and path (0:40)
-
StartDemo (1:34)
-
StartStep 5: document the API parameters (1:14)
-
StartSample parameters (3:35)
-
StartStep 6: document the API responses (0:34)
-
StartSample response (1:55)
-
StartStep 7: export the API documentation (1:59)
Writing API Documentation Using Postman and GitHub Wiki Pages
Available in
days
days
after you enroll
-
StartSection introduction (5:32)
-
StartWhat will you learn in this section? (1:00)
-
StartTools we will use (1:40)
-
StartWhat's the story? (2:02)
-
StartWhat is Postman? (1:18)
-
StartDownloading and getting to know Postman (4:03)
-
StartUsing Postman, document the usage of the Stripe API (2:03)
-
StartStep 1 (5:08)
-
StartStep 2 - part 1 (4:27)
-
StartStep 2 - part 2 (0:41)
-
StartStep 3 (3:13)
-
StartStep 4 (8:27)
-
StartStep 5 (33:54)
Frequently Asked Questions
When does the course start and finish?
The course starts now and never ends! It is a completely self-paced online course - you decide when you start and when you finish.
How long do I have access to the course?
How does lifetime access sound? After enrolling, you have unlimited access to this course for as long as you like - across any and all devices you own.
What if I am unhappy with the course?
We would never want you to be unhappy! If you are unsatisfied with your purchase, contact us in the first 30 days and we will give you a full refund.