Guidelines

A collection of 12 posts
Documentation Driven API Design

Documentation Driven API Design

API Documentation Documentation doesn’t have to be as herculean a task as it is made to appear. This assumption has made documentation to be seen as something to be done as an afterthought, which is usually a nightmare for any developer who has been assigned the difficult task of »
Top 5 REST API Security Guidelines

Top 5 REST API Security Guidelines

When developing REST API, one must pay attention to security aspects from the beginning. In this post I will review and explain top 5 security guidelines when developing and testing REST APIs. REST (or REpresentational State Transfer) is a means of expressing specific entities in a system by URL path »
RESTful API Authentication Basics

RESTful API Authentication Basics

Almost every REST API must have some sort of authentication. One of the most common headers is call Authorization. Wait a minute, we are talking about authentication but why the Authorization header? Authentication vs. Authorization The distinction between authentication and authorization is important in understanding how RESTful APIs are working »
5 Basic REST API Design Guidelines

5 Basic REST API Design Guidelines

As soon as we start working on an API, design issues arise. Robust and strong design is a key factor for API success. A poorly designed API will indeed lead to misuse or – even worse – no use at all by its intended clients: application developers. Creating and providing a state »
RESTful API Basic Guidelines

RESTful API Basic Guidelines

Your data model has started to stabilize and you're in a position to create a public API for your web app or your device. You realize it's hard to make significant changes to your API once it's released and want to get as much »