Documentation is arguably the most important part of any API strategy, as it’s often the direct route between developer and user, and a direct conduit through which the developer can inform, educate, and contextualize. Accordingly, finding good options for documenting your API is of prime importance. Read more
Posts Tagged: documentation
We walkthrough using APIcurio, an API design editor supporting OpenAPI Spec.Having a thoroughly documented, machine-readable API is considered top of the line development. However, creating a consistent format for the API and documentation is challenging with no outside guidance or structure. Read more
“Reference docs do not constitute developer portals.”
This was the crux of a talk given by Nordic APIs veteran and Pronovix CEO Kristof Van Tomme at our 2017 Platform Summit. His opinion is that developer portals should function as self-service hubs for APIs, allowing developers to access APIs without having to wait around for access keys or any additional information. Read more
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
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