Posts Tagged: API design


5 Potential Benefits of Integrating GraphQL

GraphQL is incredibly powerful — so powerful, in fact, that it is used by corporations such as Facebook to drive their large, complex social systems for billions of users. Despite this, the language is still relatively nascent, and its usage has yet to reach the dizzying heights that those languages it replaces and augments occupy. Read more

Most common instances of unrestful APIs

The API that Defied REST: Most Common Instances of unRESTful APIs, and What Really Matters

RESTful design is akin to the graphical user interface on modern computers — ubiquitous enough to be considered the de facto choice, but in practice, not necessarily the only option. REST is certainly considered by many to be the king of the hill, but it’s wrong to think it’s the only player in town. Read more

Tips and Tools for Debugging APIs

Tips and Tools for Debugging APIs

Benjamin Franklin once famously said “in this world nothing can be said to be certain, except death and taxes”. For the software developer, the saying should be amended to read “except death and taxes — and software bugs.”

It’s an unfortunate fact that the very nature of software development, especially in the collaborative environments popular amongst coders and companies today, makes software bugs inevitable. Read more


What is the Difference Between API Documentation, Specification, and Definition?

Few things are as important to an industry as common understanding and definitions. Without knowing exactly what industry-specific terms mean, and how they apply to given situations, little discourse API development can take place. It seems strange, then, that there are still so many terms in the API space that are misunderstood or misused. Read more

Building and Enforcing an Internal API Style Guide

API Design: Building and Enforcing an Internal Style Guide

In our recent post on tips for starting a public API journey we touched briefly on the idea of creating a style guide that helps API providers produce well-constructed and consistent APIs as part of their public API offering. The creation of an API style guide is, however relevant for API providers regardless of whether they are providing APIs externally or internally: It provides the context for their development efforts whether it be outsourced or created internally and is an important tool for achieving some level of governance across the organization. Read more