YoVDO

Creating API Documentation

Offered By: LinkedIn Learning

Tags

API Documentation Courses Software Development Courses Technical Writing Courses Confluence Courses Postman Courses REST APIs Courses API Design Courses Swagger Courses

Course Description

Overview

Learn how to write API documentation that’s clear, concise, approachable, and easy for consumers to use.

Syllabus

Introduction
  • Introduction to APIs
1. API Foundations
  • What is an API?
  • Types of APIs
2. API Documentation
  • What is API documentation?
  • The importance of API documentation
3. Components of API Documentation
  • Name, description, and endpoints
  • Authorization, parameters, and headers
  • Request and response
4. Integrating Documentation with API Tools
  • Swagger
  • Postman
  • Confluence
Conclusion
  • Next steps

Taught by

Deepa Maddala

Related Courses

Software as a Service
University of California, Berkeley via Coursera Software Testing
University of Utah via Udacity The Hardware/Software Interface
University of Washington via Coursera Software Debugging
Saarland University via Udacity Introduction to Systematic Program Design - Part 1
The University of British Columbia via Coursera