Posts Tagged: documentation

What GDPR Means For API Developers

Introduced in 2016, and implemented in 2018, GDPR (General Data Protection Regulation) was introduced to give individuals throughout Europe more control over their personal data.

Compliance caused plenty of headaches for businesses, both inside and outside of the EU, with many frantically sending out batch emails to confirm that individuals had opted in to hear from them. Read more

Three Key Steps for Scaling a Developer Portal

Quality API documentation is unquestionably the lifeblood of the developer experience. Most self-service tools require detailed tutorials, even for simple use. We know developer adoption drives the success of numerous APIs, so why not make their lives as easy as possible? Read more

AsyncAPI: 2020’s Industry Standard For Messaging APIs?

The industry is made up of a wide variety of implementations, solutions, and frameworks. Within this cloud of competing systems, the messaging API fights for a very specific, often niche section of development efforts. The quest to find a strong standard for these types of APIs, then, is a continuing effort. Read more

Review of Optic

We review Optic, a tool for auto-documenting and testing APIs

There are few things as important to the API developer experience as API specifications and API documentation. Both provide a vital conduit between the API provider and developer user, expressing critical information on functional aspects of the API. Read more

Do API Standards Differ From Industry to Industry?

At first glance, it would seem that the API space has embraced unified design standards. RESTful development uses HTTP to communicate between a client and a server. OpenAPI Spec serves to extend REST APIs, improving documentation and making APIs machine-friendly.

However, with just a little digging, it becomes apparent that this isn’t always the case. Read more