By Hilary Weaver-Robb, Senior Software Engineer, Quicken Loans

Hilary has worked in software quality for more than 13 years, often diving into new technologies and techniques as projects evolve. She has given online courses, workshops and presentations around the world with a focus on software quality, especially around API testing and advocating for testers to get more familiar with the code they’re testing.

Abstract

API documentation is important, especially when consumers outside of your team or company are using your APIs. Consumers should understand how to use your API in various scenarios, and sometimes documentation isn’t enough. Including real code examples (not just snippets) of how your API works will help your consumers fully understand how to use it and get it up and running much quicker. Implementing your API from a consumer-focused perspective can help improve how it functions and the overall experience for consumers.

#aws #aws-lambda #api