Gartner Research

A Guidance Framework for Testing Web APIs

Published: 06 July 2015

ID: G00270833

Analyst(s): Sean Kenefick


Cloud, mobile and Web applications routinely rely on API functionality, and the developers that consume them require effective, high-quality SDKs. Please your API consumers and stay competitive by ensuring that your developers and testers properly test your APIs.

Table Of Contents

Problem Statement

The Gartner Approach

The Guidance Framework

  • Creating and Validating Testable RESTful APIs
    • Step 1. Architect a Usable and Testable API
    • Step 2. Fulfill Traditional Testing Spectrum
    • Step 3. Validate Your API Policies After Publishing

Risks and Pitfalls

  • You Won't Know How Your Consumers Will Use Your API Until They're Using It
  • Different APIs Depend on the Same Upstream Components
  • Testers Must Test APIs Cobbled Together From Disparate Sets of Services
  • Developers Provide Testers With Constantly Changing Interfaces
  • Related Guidance

Gartner Recommended Reading

©2021 Gartner, Inc. and/or its affiliates. All rights reserved. Gartner is a registered trademark of Gartner, Inc. and its affiliates. This publication may not be reproduced or distributed in any form without Gartner’s prior written permission. It consists of the opinions of Gartner’s research organization, which should not be construed as statements of fact. While the information contained in this publication has been obtained from sources believed to be reliable, Gartner disclaims all warranties as to the accuracy, completeness or adequacy of such information. Although Gartner research may address legal and financial issues, Gartner does not provide legal or investment advice and its research should not be construed or used as such. Your access and use of this publication are governed by Gartner’s Usage Policy. Gartner prides itself on its reputation for independence and objectivity. Its research is produced independently by its research organization without input or influence from any third party. For further information, see Guiding Principles on Independence and Objectivity.

Already have a Gartner Account?

Become a client

Learn how to access this content as a Gartner client.