Posts Tagged: API Docs

How Bad Developer Portals Kill APIs

“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

The End of API Documentation As We Know It

On the one hand, having proper API documentation can be a sign of early success for an API provider, allowing new users to effectively understand the functionalities and caveats behind an API solution.

On the other hand, extensive documentation could indicate an overly complex solution with far too many variables to navigate. Read more

Use Automatic API Documentation Testing To Supercharge API Growth

It’s a universal truth that testing for errors, and debugging any that show up, isn’t a fun process.

Almost all API providers are familiar with the process of monitoring and testing. Before you commit code, API behaviors must be thoroughly vetted, as with any software release. Read more

3 Methods to Documenting JSON APIs

3 Methods for Documenting JSON API Services

JSON is a very powerful, open standard format that is used by many services and APIs across the internet. Unfortunately, while open standard carries a lot of good, it also creates some pitfalls that developers may not be prepared to handle. Read more