Welcome!

Agile Computing Authors: Stackify Blog, Yeshim Deniz, Elizabeth White, Pat Romanski, Shelly Palmer

Related Topics: @CloudExpo, Java IoT, Agile Computing

@CloudExpo: Blog Post

Secrets of the Usable REST API By @JKRiggins | @CloudExpo #API #Cloud

First and foremost, developer experience matters

Secrets of the Usable REST API
by Jennifer Riggins

Teowaki founder Javier Ramirez kicked off his Future of Web Apps presentation with a striking headline from a local town newspaper:

"I've been posting my letters in the dog poo box for two years."

In an effort to class up the North Yorkshire town (or perhaps to save on supplies), the town had painted dog waste bins the same elegant red of the public mailboxes.

"Everybody agrees web usability is a good investment." Ramirez said, but "When I use an API, usability is not that cool," he said, then running through the tedious process to get information via the Amazon API. "Ten simple steps," he said, tongue in cheek.

How can we compare this poo faux pas to Amazon, you ask?
First and foremost, developer experience matters. And as your developer customer evolves, so must the way you develop an API for them. That, and when your API evolves, make it clear to everyone involved - by proper municipal signage or documentation - whichever the situation calls for.

And thus began Ramirez's talk on "Writing Usable REST APIs."

I would argue that his advice could be applied to all forms of the application programming interface or perhaps all apps and websites in general. After all, usability is in the eye of the developer.

Remember, "If a developer doesn't use your API, they won't tell you what they don't like."

What is API usability?
Let's first start with the more common definition. Gary B. Shelly wrote:

"Web usability is an approach to make websites easy to use for an end user, without the requirement that any special training be undertaken."

Jakob Nielsen in his Usability 101 elaborated the five quality components of usability:

  • Learnability: In order for people to use your product, it has to be easy to learn how to use it.
  • Efficient: Once I learn it, I want to use it efficiency. I don't want to go through the tutorial every time.
  • Memorability: It has to be easy to remember how it was, you don't have to learn every time.
  • Errors: Give sensible error messages.
  • Satisfaction: Always a priority in usability.

Ramirez argues that, by applying these five principles, you can also bring about API usability.

How do you know if your API is usable?
Some might say usability testing has no place in the API world. I'm inclined to disagree, but until that's a trend, certainly dogfooding your API should be a no-brainer - if you don't want to use it, who will?

We like to cite Amazon Web Services as the original dogfooder, but we really should give kudos to Mike Scott, then president of Apple who banned the Macintosh's main competitor - the typewriter - from the premise back in 1980.

Within two years, typewriters were essentially obsolete as a company was built upon dogfooding.

Different nerds; different needs
This is Ramirez's way of saying my dad's favorite: "You know what happens when you assume..." You can't just stop at dogfooding because you can never assume anyone is going to use your API in the same way.

"As my girlfriend tells me time and again: ‘Javi, you are not an example of anything'."

Similarly, don't assume that everyone knows the same as you, the developers that built this API. Ramirez suggests that when you are making a REST API available to the masses, the easiest thing is to put everything you can into the query stream, which he says is quite good when people are learning, but afterwards, they can hide it in the headers.

And don't be an over-sharer. He reminded us not to expose your implementations details, focusing on resources not whole database tables.

Don't reinvent the API
"As of today, you don't need to implement your own authentication." In fact, Ramirez said, "don't implement something new, don't try to be too smart" at all. "If something is already available, someone has already been thinking about it for a long time."

Similarly, he argues, whenever possible, just use the standards that are available. "If you don't like a standard too much, that's too bad."

Your API is your best way of communicating with developers
Perhaps even more important than Nielsen's five, is the Ramirez one: Consistency.

"If your API behaves consistently all the time," he says you have nothing to worry about. Follow common API call patterns and, likewise, follow common fail patterns. You have to return the same error every time in order to fail consistently too.

"Just choose the code that makes sense for your application and keep it consistent," he continued.

Ramirez later offered the example of a Twitter quota where it's clear in the metadata of how many API calls you have made and can make but, for many APIs, it's not that clear at all.

But communication isn't just about writing clear code. It's about proper API documentation. In Zappos' case, they've written right into their API's error message that "If you're reading this, maybe you should be working at Zappos instead. Check out jobs.zappos.com."

Zappos Example

Go as fast as you can... when you can
"If your API is slow and someone has to call your API and wait 30 seconds to get a response, they aren't going to use you."

Ramirez went on to admit that sometimes you just can't be fast, but then you can at least be asynchronous, "But don't make developers wait for your API."

Sometimes, speed comes by not having a clunky API. Netflix started out with what Ramirez calls its OSFA or One Size Fits All API, but they found they could be more agile by providing a series of REST APIs.

"What they did is that they move away from that system to what they call an experience[-based] API" Depending on device, different experience, "and I'm going to give you a different API adapted for that experience."

When you're having two billion requests to your API per day, it really helps to do different requests for different devices. This led to a better developer experience, a better user experience, and it cut a huge amount of expenses by saving bandwidth.

Is Hypermedia the secret to the Usable REST API?
Ramirez doesn't offer any secret formula but he offers certain ways he believes you can more easily deliver a better developer experience.

First and foremost, he believes hypermedia makes for more navigable APIs through the Hypermedia Application Language Standard or HAL, allowing you to embed several resources in a single request.

To some extent, "if there is an alignment of the planet and the sun, you can do versioning without versions," and you can create a link to give me information for a new object. "By doing those things and also using hypermedia, you can do great things," Ramirez assured.

And fitting nicely with hypermedia APIs, he also recommended you just go and build your API with JSON, as he is among many that believe this will eventually be the standard.

Of course, a good developer experience comes with great API documentation, which he said should include:

  • code examples
  • philosophy
  • resources
  • where you do

Ramirez went on to suggest you use Swagger to write your API documentation, as well as allowing you to "play with your API without writing any code."

Don't forget
Ramirez said two things that are most important in order to balance your business with your developer experience:

  • Model your API around your business not around your internal architecture, which comes with benefits like moving to another version without breaking your API.
  • And always remind your team: "I don't care about companies; I care about people doing things."

When you are looking to build a usable REST API or any amazing developer experience, you need to ask yourself these questions and more:

  • Should my API allow asynchronous creation, update, and deletion?
  • Should my API ignore unrecognized parameters silently, even when it is getting a valid request, or should it return and error?
  • Should it allow bulk operations?
  • Does API need real-time?

"There are not good or bad answers. Every API is different. Every user base is different. The only wrong answer is copying and pasting from the last project," Ramirez said.

Most importantly, you must always ask yourself: Would I want to use it?

Read the original blog entry...

More Stories By SmartBear Blog

As the leader in software quality tools for the connected world, SmartBear supports more than two million software professionals and over 25,000 organizations in 90 countries that use its products to build and deliver the world’s greatest applications. With today’s applications deploying on mobile, Web, desktop, Internet of Things (IoT) or even embedded computing platforms, the connected nature of these applications through public and private APIs presents a unique set of challenges for developers, testers and operations teams. SmartBear's software quality tools assist with code review, functional and load testing, API readiness as well as performance monitoring of these modern applications.

@ThingsExpo Stories
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
Imagine if you will, a retail floor so densely packed with sensors that they can pick up the movements of insects scurrying across a store aisle. Or a component of a piece of factory equipment so well-instrumented that its digital twin provides resolution down to the micrometer.
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settle...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
BnkToTheFuture.com is the largest online investment platform for investing in FinTech, Bitcoin and Blockchain companies. We believe the future of finance looks very different from the past and we aim to invest and provide trading opportunities for qualifying investors that want to build a portfolio in the sector in compliance with international financial regulations.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
When shopping for a new data processing platform for IoT solutions, many development teams want to be able to test-drive options before making a choice. Yet when evaluating an IoT solution, it’s simply not feasible to do so at scale with physical devices. Building a sensor simulator is the next best choice; however, generating a realistic simulation at very high TPS with ease of configurability is a formidable challenge. When dealing with multiple application or transport protocols, you would be...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
We are given a desktop platform with Java 8 or Java 9 installed and seek to find a way to deploy high-performance Java applications that use Java 3D and/or Jogl without having to run an installer. We are subject to the constraint that the applications be signed and deployed so that they can be run in a trusted environment (i.e., outside of the sandbox). Further, we seek to do this in a way that does not depend on bundling a JRE with our applications, as this makes downloads and installations rat...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...