Posts Tagged: documentation

Standard API Definitions Demystified

As with any industry, the web API space faces different approaches to standardization. Not least of which are the differences between how API providers choose to define their APIs in a machine readable way with API specifications and description languages.

API definitions have emerged as ways to annotate API functionalities, and there are still many out there catering to varying web service architectures. 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

First API implementation planning whiteboard

First Time API Implementation for Entrepreneurs

Any business or organization in the world can bring an API to market, but APIs are increasingly synonymous with the startup world. Entrepreneurs are using APIs to deliver their products for a number of reasons:

  • They can provide a convenient, easily understood and accessible mechanism for getting an MVP in front of customers;
  • Having an API in the market can provide crucial insight into the value of your product through feedback from the developer community;
  • An API can be one of several channels for delivering your product or may be the product itself.
Read more

Ultimate Guide to 30+ API Documentation Solutions

Say you have developed a web API and now want to show it to the world. Next comes documentation, and guess what — there’s a tool for that. But, in a sea of API documentation generation tools, which one is suitable to your specific environment? 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