Documenting APIs Effectively

Learn to create clear and concise API documentation that will ensure your APIs are utilized successfully by consumers. This course will teach you strategies and examples for documenting your APIs effectively.

When creating APIs, its natural to focus on the technical aspects, like constructing code, testing, building, and deploying. Too often, this results in limited or no documentation to guide consumers of the API. Over time, tools and standards have evolved to support documenting your APIs early on, tools can even automatically generate documentation and code for you. In this course, Documenting APIs Effectively, you’ll learn strategies for API documentation, leveraging best practices, and real-world examples. First, you’ll discover why API documentation is so critical to successful outcomes by consumers. Next, you’ll learn about tools and specifications that can help automate and standardize the creation and curation of documentation. Finally, you’ll see how to document the different aspects of your API, including reference documents and developer guides. When you’re finished with this course, you’ll have the skills and knowledge of API documentation needed to ensure your consumers can successfully comprehend and achieve the outcomes they expect when using your API as part of their solution.

• Course Overview 1min
• Why Is It Critical to Document APIs? 14mins
• Documenting Your APIs with the OpenAPI Specification 28mins
• Using Tooling with the OpenAPI Specification 8mins
• Creating a Developer Portal 8mins