Posts Tagged: documentation

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

How to make self-descriptive APIs

How To Make A Self-Descriptive Enterprise API

One of the hardest things to do as an API provider is to work within the enterprise environment. This is due, in large part, to the very nature of enterprise structures – often slow to adopt new technologies, fundamentally distrustful of external solutions, and far more insular than most modern corporations would like to admit. Read more

5 Frequent Developer Community Mistakes (And How To Fix Them)

We’ve been in the API game for a little while now, and we’ve seen our fair share of compelling developer communities being cultivated. On the flipside, we’ve also seen some epic fails. At our 2016 Platform Summit, Shayne Parmelee, developer experience lead at Shopify, talked about some of his own successes (and failures) during his time with the company. Read more