Category: Programming

7 Tips for Writing Better API Documentation

If an API isn’t documented, the chance of it being consumed by other developers is incredibly low. For a very long time, companies like Microsoft, Salesforce, and Apple were dominant players in technology. They were dominant players because they had a compelling product and great documentation.

Continue reading

What is an API program?

An API program is a plan that a company has developed to market, support and monetize a public API. There are thousands – maybe even tens of thousands of companies with public and open APIs.

Continue reading

How to Optimize an API

Optimization can mean a lot of things like simplifying a process, reducing data and even speeding up response time.

An API often has three different ways we can optimize it.

Continue reading

Sorting in a REST API

Sorting is determining the order of items when a list of items is returned from a particular endpoint. The best practice is to really keep things simple and consistent.

Continue reading

Date and DateTime Handling in APIs

Application Programming Interfaces and dates are just as difficult.

Timezone issues crop up because dates and datetimes are just strings in JSON, there’s nothing to necessarily say that this is a date in this format.

Continue reading

Is SOAP dead?

SOAP and XML based Web Services aren’t dead yet. I don’t think they will be for quite a while because they are very common in large enterprises (government, banks, telecommunications, etc).

Continue reading