API Design Tutorial: The Interaction Model

By pwsadmin | July 16, 2019

API design can be daunting. With so many decisions to make and so many differing opinions available on interface design, it’s easy to feel frustrated by the process.  Even worse, it’s possible to follow bad advice and end up designing an API that developers hate using. That’s why we at the API Academy stress the importance of…

Three Common Web Architecture Styles

By pwsadmin | July 16, 2019

When talking to clients about the architectural details of an implementation, one of the first questions I ask is: “What architectural style is appropriate for this Web solution?” It turns out this question stumps most of my audience. Not many system architects and developers think about it. Instead, they implement solutions using whatever components and…

If They Have to Ask, You Didn’t Afford It

By pwsadmin | July 16, 2019

My guess is you are familiar with the phrase “If you have to ask, you can’t afford it”. Well, that’s not what I mean here. Let me show you what I’m actually getting at… If They Have to Ask… Try this: Create a new Web API Get it up and running on some server or other…

Hypermedia Workflow Questions

By pwsadmin | July 16, 2019

Following a talk I gave about hypermedia APIs, I received a question from an Abiel Woldu on how to handle hypermedia support when the same backend operation is called from different workflows. Here’s part of the Abiel’s email: “Say you have an end point for validating address; call it /validateAddress. Now this endpoint is called…

When Good API Design is a Waste of Time

By pwsadmin | July 16, 2019

The idea that good design is essential to building great products and services has become a truism in our industry.  Most of us intuitively understand the idea that expending effort on the design of our code, system architecture and APIs will payoff after implementation.  I’m certainly a big believer in the power of good design…

Dr. Dobb’s: Building Successful Web APIs

By pwsadmin | July 16, 2019

The syntax of APIs matter much less than their discoverability and the ease with which developers can figure out how to use them effectively. In this article, Ronnie Mitra of the API Academy discusses the nuts and bolts of designing developer-friendly APIs.

The View from #API360

By pwsadmin | July 16, 2019

It was my great pleasure to join our inaugural #api360 event in Washington, DC, Sept 12.  The Newseum was an ideal venue, offering a stunning cityscape view including the Capitol building and, of course, the Canadian Embassy.  The day kicked off with Gray Brooks of 18F giving an insider’s view of the widespread API activities taking place in…

InfoQ: A Web API Design Methodology

By pwsadmin | July 16, 2019

Designing Web APIs is more than just URLs, HTTP status codes, headers and payloads. The process of design – what is essentially a “look and feel” for your API – is very important and is well-worth the effort. This article briefly outlines a methodology that results in an API design that takes advantage of both…

InfoQ: REST-y Reader

By pwsadmin | July 16, 2019

The API Academy’s Mike Amundsen is regularly asked which books he would recommend for those who want to learn more about designing, implementing and maintaining Web APIs. In this article, Mike offers a shortlist of books he discovered as he was learning about APIs – many of which are still among the books he consults most regularly.

A Guide to REST & API Design

By pwsadmin | July 16, 2019

CA recently released a new eBook A Guide to REST & API Design that is based (in part) on a talk I gave at the 2012 Code PaLOUsa in Louisville, KY. The approach is a bit atypical for most REST papers or presentations. I decided to focus on some of the broader issues around design in general and then…