Engineering, Science & Technology

Creating API Documentation

With so many APIs on the market, it’s hard to keep track of what’s what. For programmers, analysts, architects, and technical writers who work with APIs every day, you can’t overstate the importance of documentation that’s clear, concise, and easy to use. In this course, instructor and developer Deepa Maddala shows you how to create effective and approachable API documentation based on current best practices and integrated tools.

Learn the fundamentals of APIs and the importance of writing standardized API documentation. Explore the components of effective documentation including name, description, endpoints, authorization, parameters, headers, and request and response payloads. Along the way, Deepa gives you tips on how to integrate your documentation with tools like Swagger, Postman, and Confluence.

Learn More