@CloudExpo Authors: Pat Romanski, Liz McMillan, Ram Sonagara, Yeshim Deniz, Elizabeth White

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.

@CloudExpo Stories
Business professionals no longer wonder if they'll migrate to the cloud; it's now a matter of when. The cloud environment has proved to be a major force in transitioning to an agile business model that enables quick decisions and fast implementation that solidify customer relationships. And when the cloud is combined with the power of cognitive computing, it drives innovation and transformation that achieves astounding competitive advantage.
Digital Transformation: Preparing Cloud & IoT Security for the Age of Artificial Intelligence. As automation and artificial intelligence (AI) power solution development and delivery, many businesses need to build backend cloud capabilities. Well-poised organizations, marketing smart devices with AI and BlockChain capabilities prepare to refine compliance and regulatory capabilities in 2018. Volumes of health, financial, technical and privacy data, along with tightening compliance requirements by...
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 ...
Evan Kirstel is an internationally recognized thought leader and social media influencer in IoT (#1 in 2017), Cloud, Data Security (2016), Health Tech (#9 in 2017), Digital Health (#6 in 2016), B2B Marketing (#5 in 2015), AI, Smart Home, Digital (2017), IIoT (#1 in 2017) and Telecom/Wireless/5G. His connections are a "Who's Who" in these technologies, He is in the top 10 most mentioned/re-tweeted by CMOs and CIOs (2016) and have been recently named 5th most influential B2B marketeer in the US. H...
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 settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereal. Andrew's role at ConsenSys Enterprise is a mul...
The best way to leverage your Cloud Expo presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering Cloud Expo and @ThingsExpo will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at Cloud Expo. Product announcements during our show provide your company with the most reach through our targeted audiences.
DevOpsSummit New York 2018, colocated with CloudEXPO | DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City. Digital Transformation (DX) is a major focus with the introduction of DXWorldEXPO within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of bus...
With 10 simultaneous tracks, keynotes, general sessions and targeted breakout classes, @CloudEXPO and DXWorldEXPO are two of the most important technology events of the year. Since its launch over eight years ago, @CloudEXPO and DXWorldEXPO have presented a rock star faculty as well as showcased hundreds of sponsors and exhibitors! In this blog post, we provide 7 tips on how, as part of our world-class faculty, you can deliver one of the most popular sessions at our events. But before reading...
DXWorldEXPO LLC announced today that "Miami Blockchain Event by FinTechEXPO" has announced that its Call for Papers is now open. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to [email protected] Financial enterprises in New York City, London, Singapore, and other world financial capitals are embracing a new generation of smart, automated FinTech that eliminates many cumbersome, slow, and expe...
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City and will bring together Cloud Computing, FinTech and Blockchain, Digital Transformation, Big Data, Internet of Things, DevOps, AI, Machine Learning and WebRTC to one location.
DXWorldEXPO | CloudEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
@DevOpsSummit New York 2018, colocated with CloudEXPO | DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises - and delivering real results.
Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
"We started a Master of Science in business analytics - that's the hot topic. We serve the business community around San Francisco so we educate the working professionals and this is where they all want to be," explained Judy Lee, Associate Professor and Department Chair at Golden Gate University, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
DXWorldEXPO LLC announced today that Dez Blanchfield joined the faculty of CloudEXPO's "10-Year Anniversary Event" which will take place on November 11-13, 2018 in New York City. Dez is a strategic leader in business and digital transformation with 25 years of experience in the IT and telecommunications industries developing strategies and implementing business initiatives. He has a breadth of expertise spanning technologies such as cloud computing, big data and analytics, cognitive computing, m...
Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
There is a huge demand for responsive, real-time mobile and web experiences, but current architectural patterns do not easily accommodate applications that respond to events in real time. Common solutions using message queues or HTTP long-polling quickly lead to resiliency, scalability and development velocity challenges. In his session at 21st Cloud Expo, Ryland Degnan, a Senior Software Engineer on the Netflix Edge Platform team, will discuss how by leveraging a reactive stream-based protocol,...
DXWorldEXPO LLC announced today that Kevin Jackson joined the faculty of CloudEXPO's "10-Year Anniversary Event" which will take place on November 11-13, 2018 in New York City. Kevin L. Jackson is a globally recognized cloud computing expert and Founder/Author of the award winning "Cloud Musings" blog. Mr. Jackson has also been recognized as a "Top 100 Cybersecurity Influencer and Brand" by Onalytica (2015), a Huffington Post "Top 100 Cloud Computing Experts on Twitter" (2013) and a "Top 50 C...