The fast-growing Web API landscape brings clients more options than ever before—
Why can people easily navigate websites they’ve never encountered before? The answer is simple: because interactions patterns are reused across websites. Usability expert Jakob Nielsen observed that
users spend most of their time on other websites , reminding interaction designers and information architects to compose websites from shared patterns rather than custom ones. For example, the user interfaces to update a status message on Facebook, Twitter, and Instagram are all highly similar. The strength of reuse is confirmed by the survival of visually less obvious patterns, such as a site’s logo doubling as a homepage link, or three parallel lines forming a menu button on mobile devices. From a technical perspective, we could say people are
loosely coupled to well-designed websites, because they bind to generic interaction patterns rather than specific interfaces. The human Web maintains usability by tapping into an evolving ecosystem of interaction patterns, only inventing new interfaces as a last resort.
In contrast, the machine-based Web is characterized by a near-total lack of interface-level reuse, as even Web APIs with highly similar functionality often expose very different machine interfaces. This results in a lack of substitutability  with non-native services : clients programmed for a specific API task (such as posting a photo on Facebook) cannot perform that same task with another Web API (posting that same photo on Twitter or Flickr). Regardless of whether we classify the coupling between a client and an API as
tight , switching API providers proves difficult  as clients are forced to bind to a provider-specific interface rather than a provider-independent, abstract interface. Case in point: whereas Facebook and Twitter show a near-identical user interface for updating a status (a light-colored textbox with an encouraging question and a camera icon), the corresponding interactions with their Web APIs require a different number of HTTP requests with entirely different JSON bodies. If the human Web were designed in such a way, information consumption would slow down significantly, as accessing any new website would involve studying its documentation first—
The absence of an ecosystem of Web API interaction patterns means that every client needs custom manual programming for each provider—
If we want our applications to access similar Web APIs with the same flexibility as people browse similar webpages, we will need to fundamentally rethink the way in which the interfaces to those Web APIs are designed. Given the increasing importance and scale of the Web API landscape , it is time to evolve Web API design from a craft into a measurable discipline, focused on establishing and repeating interaction designs. The ultimate goal is a new generation of clients that are compatible with Web APIs beyond those for which they were explicitly programmed.
In this article, we study the potential of adopting a pattern-based approach to Web API design. Through the introduction of 5 principles, we port the lessons learned in human interface design to machine interface design, evaluate their impact, and discuss possible concrete technologies for implementing them. Although the description and argumentation of such a vision does not imply its immediate realization, this work aims to inspire community-wide discussions on cross-API interoperability through granular reuse.
When discussing reuse, we should distinguish an interface from its implementation, as the term
Web API often refers to both simultaneously. We will discuss (partial) interface reuse across different implementations, since we aim for service substitutability. Reuse of both human and machine interfaces can be considered from the interface user and the API implementer perspectives. Interestingly, interface-level reuse can facilitate implementation-level reuse: for instance, if different websites need the same widget, developers can implement it with the same library.
It might seem contradictory to discuss a lack of reuse in the context of Web APIs: after all, APIs are designed to enable reuse . Indeed, a Web API enables the reuse of an implementation offered by a third-party provider , and we target reuse of interfaces across providers . However, Web APIs are different in that the question is not whether to reuse or reimplement: we have already decided we need third-party functionality, and we cannot provide the user with a viable alternative of our own. For example, when providing share functionality, users will not be satisfied if their photos appear on our website; instead, they want to post those on their existing social networks. Another difference is the scale of reuse: with the ever growing number of Web APIs , new providers for existing functionality appear every day. While integrating a single API poses non-trivial but manageable problems [5, 6], integrating the same functionality from multiple APIs—
Integration concerns of individual Web APIs include initial implementation effort, coupling, and evolution. The integration of a Web API involves manual labor to (implicitly or explicitly) construct the appropriate HTTP requests programmatically. In absence of a standard , these requests are different for all APIs, even for those with related functionality . Often, insufficient documentation is available . Web APIs are frequently cited as providing
loose coupling , yet research revealed that coupling is a multi-faceted concept, with different architectural styles ranking divergently in multiple dimensions of coupling . However, the predicted rankings are only obtained in case of strict adherence to an architectural style, which is seldom the case for Web APIs. Furthermore, some dimensions, such as evolution and granularity, always depend on the implementation . Coupling is not only a problem for cross-API compatibility, but also for cross-version compatibility within the same API [5, 10]. Since clients necessarily depend on the Web API provider’s pace of evolution, upgrading between versions can come at a considerable cost, which is forced upon client developers .
Yet the biggest problems occur when trying to integrate the same functionality from different Web APIs. While the interface might loosely couple clients to the server’s underlying implementation of functionality, that same interface in practice tightly couples clients to one specific provider of that functionality. No coupling is loose enough to enable switching providers without changing client code (except for the few cases where entire APIs are standardized). These issues arise because, while hiding the implementation, the interface is the result of a unilateral decision  that insufficiently abstracts its functionality. Nonetheless, substitutability of different APIs is important to enable competition on factors such as price and quality , to let end-users decide where to read and/
Several strategies for circumventing the above intra- and cross-API problems providing symptomatic relief instead of addressing the root causes, thereby unwittingly enabling those problems to persist and grow worse. Documentation can simplify integration of a client to one API , but the necessity of studying documentation beforehand becomes a significant burden when setting up multiple integrations. Recall in this context that the corresponding webpages—
From the above, we conclude that today’s clients still cannot request conceptually identical functionality from a different Web API provider without changing client-side code. The coupling between a client and the interface of a Web API is insufficiently loose for substitutability between different providers. To overcome this, we propose designing APIs at an abstraction level that enables clients to automatically determine semantic compatibility and invocation mechanics  at runtime.
Now that we have established the
feature concept, we introduce 5 incremental principles for the design of feature-based Web APIs. We discuss each principle in a technology-agnostic way, and describe the situation before and after its application, followed by current and/
This principle breaks up a monolithic custom interface into clearly delineated interface parts that can be reused across different APIs. The input and output of features should reuse specific subsets/
Before: Clients bind to a provider-specific interface to access certain functionality. Neither client- nor server-side code related to the interface can be reused, because each server has a different interface.
After: Clients bind to individual features to access functionality, so they are unaffected by changes in other features. Server-side code related to the feature’s interface and implementation can be reused in a granular way, as reusers are not required to copy the entire interface.
Examples: accessing and updating a list of items, obtaining a sorted view of items, pagination, updating a status message, uploading a photograph, the OpenSearch specification for search and autocompletion, the Atom standard for viewing and managing collections
This principle is based on the observation that many clients only use a fraction of a service’s functionality , and is thereby related to the interface-segregation principle, which states that clients should not depend on methods they do not use. It differs from the concept of a microservice architecture in that features are interface parts of a larger Web API’s interface, whereas a microservice is an
independently deployable service that
can run in its own process . Features might be realized as microservices internally, but clients do not need to know whether this is the case.
While each Web API is different, similar functionality appears in many of them, at a scale that grows faster than is the case with operating system or software framework APIs. This second principle therefore encourages architects to first check whether a part of the API is already available as a feature elsewhere, before implementing their own feature.
After: Since features are reused across APIs, clients that are compatible with a set of features can perform their task with any API that offers these features, regardless of provider. Client- and server-side documentation, tooling, and libraries for certain features can be reused across implementations.
Examples: using Atom for blog posts across providers, using Atom for a collection of tweets (instead of the current Twitter-specific interface), a generic status update feature (instead of a provider-specific one)
Assuming that every Web API can be cleanly separated into existing features would of course be unrealistic, so this principle does not demand that. Instead, architects should prioritize reuse of features where applicable, and package (only) the remaining provider-specific functionality as separate features. In order for features to be widely applicable, they should possess a certain extent of flexibility, which is discussed in the next two principles. Features can have a dependency on each other, for instance, sorting a list can depend on browsing a list. However, they do not directly interact with each other: the client decides whether or not to use multiple features in combination.
When servers include or link to the list of features they support, clients can automatically verify their semantic compatibility with the Web API. Support should be explicitly indicated in-band inside of the HTTP response, either through headers or inside of the response body.
After: Clients can determine whether a given API offers the features they require. If feature support varies dynamically (based on authentication or other factors), clients can find out at runtime. In case of incompatibility, clients can explain what features are missing. Clients can ignore the presence of non-supported features.
This principle realizes the self-describing messages constraint of REST , relying on message extensibility  rather than provider-specific media types , for instance through the use of profiles  to constrain more generic media types. In addition to signaling the presence of the features themselves, the server might indicate to what extent they are supported, for instance, which optional parts are implemented.
Describing invocation mechanics and functionality might seem redundant, given that the third principle already mandates the identification of features. However, this fourth principle decouples features from specific URL or request body templates, since these details are now communicated at runtime. Descriptions can be provided in-band in the response body or, if the identifier is a URL, by dereferencing the identifier. Through descriptions of functionality—
Before: Clients only receive a feature’s identifier, so they are coupled to out-of-band details that have to be known beforehand. All APIs have to implement a feature with the exact same URL structure and parameter names.
After: Clients are coupled only to an abstract interface of a feature, the details of which are communicated at runtime. Servers are free to choose their own URLs and names, as they explicitly indicate their mapping to the feature.
This principle concerns the hypermedia constraint of REST , and provides an explicit way for customizing and extending features by describing optional or additional parameters. Cross-API integration of features is facilitated by allowing each API to describe its own URI and form templates, authentication, content types and profiles, etc. Beyond the substitutability this brings current clients, new possibilities for future clients arise. For instance, interactive clients can automatically generate forms for features they have not encountered before. By additionally describing functionality, clients can gain an understanding of what a feature does and, depending on the formalism and capabilities of the client, access features for which they have not been explicitly designed.
This final principle ensures that the properties of features become quantified, such that architects can understand the impact of enabling certain features on their Web API. On the human Web, the effectiveness of interface components is routinely measured through in-browser analytics, and interfaces are tweaked to optimize user efficiency. By testing conformance with a certain feature, and measuring clients, servers, and caches, we can determine how a certain application task is affected by a feature or combination of multiple features. While server load, bandwidth, and cache efficiency are typically important aspects, the relevance of dimensions depends on the feature. Importantly, we focus on measuring the interface across implementations in order to understand its inherent trade-offs. Note that this principle differs from monitoring, which assesses the current state of a Web API; instead, we aim to analyze the estimated impact of a feature beforehand.
Examples: The expressivity of a query-based interface feature has a strong impact on how a client completes a certain information task, as it influences the required number of requests, bandwidth, cache effectiveness, maximum per-request cost, and server load .
Depending on what features are available, a client might be able to complete a certain task with different quality attributes. For example, if the server only supports a pagination feature, the client needs to download all pages of a list in order to find the 5 cheapest products. If the client additionally detects a sorting feature, it can obtain the same answer with a single request. However, in the second case, the API exposes its data in more variations, which impacts cache efficiency, and requires additional computations, which impacts server load. This indicates that the behavior of a Web API under different circumstances is determined by the presence of certain features. Crucially, this effect is not (only) implementation-dependent, but also interface-dependent, since similar trends can occur per interface regardless of underlying implementations . Providers could use this information to decide whether to enable a feature in the free or paying version of an API, and clients might opt to pay for more expressive features if this allows them to complete tasks more efficiently.
This article examines the potential impact of a feature-based ecosystem for Web APIs. However, bridging the gap from the theory to an actual realization is non-trivial, as the initiative needs to be carried by a larger community. It is crucial that we agree on the base technologies for each principle, especially for the description of features, for which several competing technologies exist. Furthermore, we need to specify or standardize data structures and profiles of media types to achieve message-level interoperability. Otherwise, we risk fragmentation of the community based on differences in the technological stacks, for the mechanisms surrounding a feature’s description and interaction. Good initial use cases are those that demand sustainability over a longer period of time, such as the long-term publication of data by archives and other institutions, who currently employ a mix of standardized and non-standardized APIs. Feature-based interfaces recently gained interest for data integration purposes, as they countered problems with existing APIs in a methodical way . To make this approach spread to other communities, potential obstacles need to be considered, some of which we discuss below.
The cost of reuse  is well-documented in literature. However, calculations of that cost typically consider whether a specific use case benefits from reuse. In the case of Web APIs, we have already decided we need to reuse server-side functionality; as such, the associated expenses will occur in any case. The question is rather how we can reduce those expenses, while offering an equal or higher number of API integrations. Our bottom-up approach addresses this by limiting the dependency of clients to a number of reusable features instead of a provider-specific interface, allowing reuse of client and server code, documentation, and tooling across implementations. However, developing an ecosystem of features also comes at a cost. As mentioned above, a community will need to reach consensus on their definition and design, and standardization can evolve slowly.
Incentives for client and server developers are an important issue. Convincing major players to reuse API features might be difficult when they have the power to push any API they desire , especially if they benefit commercially from non-compatibility with competitors’ APIs. However, improving the developer experience is also in their best interest. Nonetheless, we might want to approach adoption from a bottom-up perspective as well, and focus on small to medium players. For them, reusing API features means making their API compatible with existing clients. For example, consider a local restaurant that aims to provide a reservation Web API: when other restaurants reuse a table reservation feature, it is more likely that an adequate client will already exist. In absence of reuse, and despite hosting their own website for humans, restaurants now resort to paid centralized APIs, which come with provider-specific machine clients.
Automated clients on the Web do not enjoy the same flexibility as people: switching between different providers of a similar service is labor-intensive. Web APIs lack recognizable interface patterns, even though machines need these more than humans. Hence, we proposed a feature-based method to construct the interface of Web APIs, favoring reuse over reinvention, analogous to component-driven interaction design on the human Web. We emphasized a quantifiable approach to arrive at an ecosystem of reusable features with a well-understood impact on Web APIs.
Such an ecosystem changes Web server and client development in three major ways. First, clients gain the ability to interact with multiple similar Web APIs rather than only one. This reduces development costs because client-side code and frameworks can be reused across different Web APIs and over time. Server interface design starts with selecting appropriate patterns based on functional and non-functional characteristics. Second, an ecosystem broadens an end user’s choice from specific client/
Furthermore, a feature-based design opens up new possibilities to scale individual APIs by enabling and disabling features at runtime. For example, during peak hours, server load can be reduced by selectively switching off features, and clients can automatically detect this and adjust. Alternatively, certain features could be activated depending on clients’ subscription plans. More complex functionality (with higher server load) can be reserved for paying customers; less complex operations that achieve the same result (with higher client investment) can be available freely or at a lower price.
While this article outlines the principles for an ecosystem and suggests potential technologies to demonstrate its feasibility, we purposely leave the choice for a specific technological stack open. As experience with standards such as SOAP and WSDL has shown, the main obstacle is not technological, but rather a question of how technologies are applied to achieve reuse and, in the case of Web APIs and features, at what granularity.
What an ecosystem needs foremost is a community of adopters to foster it. This involves creating the right incentives and encouraging an appropriate mindset. It is tempting to create customized Web APIs, certainly if economic motives against substitutability exist. Reuse, at its core, is about opening up development, dissolving borders, and realizing cross-fertilization between different parties. This challenges current Web APIs practices and the business models created around them. It forces us to think at a longer temporal scale, perhaps even further ahead in the future than the typical lifetime of many Web APIs. This will require an active community that maintains a repository of features in the long term.
Our plea for reuse, however, is only a means to an end: the ultimate goal is empowering automated clients on the Web. After all, the major innovation of the Web is its uniform interface, enabling generic clients such as Web browsers to access a multitude of information and service providers. Despite a uniform protocol, machine clients remain confined to provider-specific interaction mechanisms, much like we have been before the Web. The logical next step is the realization of provider independence for machine clients, so they can also freely interact with the open Web.
- Nielsen, J. (2000), “End of Web Design”, July, available at: http://www.nngroup.com/
- Ponnekanti, S. and Fox, A. (2003), “Application-service interoperation without standardized service interfaces”, in Proceedings of the First IEEE International Conference on Pervasive Computing and Communications, pp. 30–37, available at: http://dx.doi.org/
- Ponnekanti, S. and Fox, A. (2004), “Interoperability Among Independently Evolving Web Services”, in Jacobsen, H.-A. (Ed.), Proceedings of the International Middleware Conference, Springer, pp. 331–351, available at: http://dx.doi.org/
- Pautasso, C. and Wilde, E. (2009), “Why is the Web loosely coupled? – A multi-faceted metric for service design”, in Proceedings of the 18th International Conference on World Wide Web, ACM, pp. 911–920, available at: http://www2009.eprints.org/
- Espinha, T., Zaidman, A. and Gross, H.-G. (2015), “Web API growing pains: Loosely coupled yet strongly tied”, Journal of Systems and Software, Vol. 100, pp. 27–43, available at: http://www.sciencedirect.com/
science/. article/ pii/ S0164121214002180
- Robillard, M. and DeLine, R. (2011), “A field study of API learning obstacles”, Empirical Software Engineering, Vol. 16 No. 6, pp. 703–732, available at: http://dx.doi.org/
- Tan, W., Fan, Y., Ghoneim, A., Hossain, M.A. and Dustdar, S. (2016), “From the Service-Oriented Architecture to the Web API Economy”, IEEE Internet Computing, Vol. 20 No. 4, pp. 64–68, available at: http://dx.doi.org/
- Sametinger, J. (1997), Software Engineering with Reusable Components, Springer Science & Business Media, available at: https://www.springer.com/
gp/. book/ 9783540626954
- Sillitti, A., Vernazza, T. and Succi, G. (2002), “Service Oriented Programming: A New Paradigm of Software Reuse”, in Gacek, C. (Ed.), Software Reuse: Methods, Techniques, and Tools, pp. 269–280, available at: https://doi.org/
- Fokaefs, M. and Stroulia, E. (2012), “WSDarwin: Automatic Web Service Client Adaptation”, in Proceedings of the 2012 Conference of the Center for Advanced Studies on Collaborative Research, IBM Corp., pp. 176–191, available at: http://dl.acm.org/
- Benatallah, B., Casati, F., Grigori, D., Nezhad, H.R.M. and Toumani, F. (2005), “Developing Adapters for Web Services Integration”, in Pastor, O. and Falcão e Cunha, J. (Eds.), Proceedings of the 17th International Conference on Advanced Information Systems Engineering, Springer, pp. 415–429, available at: http://dx.doi.org/
- Fielding, R.T. (2000), Architectural Styles and the Design of Network-Based Software Architectures, PhD thesis, University of California, available at: http://www.ics.uci.edu/~fielding/
pubs/. dissertation/ top.htm
- Wilde, E. (2007), The ‘Profile’ Link Relation Type, No. RFC6906, Internet Engineering Task Force, available at: https://www.ietf.org/
- Balalaie, A., Heydarnoori, A. and Jamshidi, P. (2016), “Microservices Architecture Enables DevOps: Migration to a Cloud-Native Architecture”, IEEE Software, Vol. 33 No. 3, pp. 42–52, available at: http://dx.doi.org/
- Verborgh, R. (2016), “Your JSON is not my JSON – A case for more fine-grained content negotiation”, in Proceedings of the Workshop on Smart Descriptions & Smarter Vocabularies, available at: https://ruben.verborgh.org/
- Verborgh, R., Vander Sande, M., Hartig, O., Van Herwegen, J., De Vocht, L., De Meester, B., Haesendonck, G., et al. (2016), “Triple Pattern Fragments: a Low-cost Knowledge Graph Interface for the Web”, Journal of Web Semantics, Vol. 37–38, pp. 184–206, available at: http://linkeddatafragments.org/
- Morisio, M., Ezran, M. and Tully, C. (2002), “Success and Failure Factors in Software Reuse”, IEEE Transactions on Software Engineering, Vol. 28 No. 4, pp. 340–357, available at: http://dx.doi.org/