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

Postman - Intro to APIs (without coding)
Coursera Project Network via Coursera NEW:Angular Material: The full guide using a Spring boot API
Udemy Generate API Documentation from Postman
Coursera Project Network via Coursera Node.js API Masterclass With Express & MongoDB
Udemy Documenting an ASP.NET Core API with OpenAPI / Swagger
Pluralsight