A Guidance Framework for Designing a Great API
Overview
APIs are fundamental to effective web/mobile app, microservice and integration architectures.
APIs enable third-party developer ecosystems and allow businesses to capitalize on new digital business opportunities.
- Publishing an API is a way for your organization to benefit from those smarter people's ideas and execution.
Today's APIs predominantly use web technologies, such as HTTP/Transport Layer Security (TLS) and JavaScript Object Notation (JSON).
Poor API design can have long-reaching consequences, including:
- Higher maintenance costs
- Frustrated users
- Loss of revenue
- Missed business opportunities
Shifting from an application-centric to an API-centric mindset presents significant challenges and requirements for designing, testing and managing APIs.
The Guidance Framework
A consumer-driven approach requires that you:
- Identify the developers who will consume your API, and engage with them throughout the life cycle of the API.
- Carefully design legal and technical contracts that match the needs of your business, as well as those of the API consumers.
- Select development approaches that allow you to implement the API effectively and consistently.
- Apply an API life cycle management strategy to enable consistent governance of the API.
