Posts Tagged: API Definition

Why You Should Be Designing APIs to Spec

There’s a good reason why building APIs can be extremely tough and time-consuming: they have to cater to both human and machine needs.

Inherently, this is pretty difficult. Machines are picky and rely on pure logic; they crave rigid, hierarchical structures and definite instructions. Read more

7 Items No API Documentation Can Live Without

Web APIs are highly variable things – they can be custom-built, designed around a single purpose, all-encompassing, and almost everything in between. Shifting requirements dictate what the interface is comprised of. Due to this, it’s hard to find commonalities between APIs and their user-facing portals. Read more

What Should You Consider Before OpenAPI Adoption?

The OpenAPI Specification is adored, and its usefulness has seen it be subject to sweeping adoption in recent years. It’s clear that many see the value of the OpenAPI Specification, and see value in its adoption.

As with any trend, there’s a certain amount of consideration that should be paid before adopting the solution carte blanche. Read more

Tooling Review: AsyncAPI

Documentation will set you free – this is a mantra often delivered by experienced developers, and it bears repeating whenever the value of documentation is discussed. Simply put, documentation is perhaps one of the most important elements of effective API developer communication, second only to active demonstrations, tutorials, and other interactive systems. Read more

5 Ways the OpenAPI Specification Spurs API Agility

OpenAPI Specification can be used to secure and accelerate the API lifecycle.

The API lifecycle is a topic of much discussion — and rightfully so. The API space is agile, ever changing, and its participants must continually meet the shifting kaleidoscope of user needs and demands. Read more