Design

A collection of 9 posts
API Development with Design-first Approach

API Development with Design-first Approach

Today, the best practice when implementing APIs on a large scale is to start with an API design stage. This approach is called API design-first, sometimes also known as API-first, schema-first, or design-first. The design-first approach advocates for designing the API’s contract first before writing any code. This is »
Top 5 REST API Design Problems

Top 5 REST API Design Problems

Here at RestCase we are working with many companies and help them develop secure services and APIs. When working with developers on how to design and build quality APIs and microservices and I am seeing many common design problems that are not organization / company-specific. These problems are better to be »
Top 5 OWASP Security Tips for Designing Secured REST APIs

Top 5 OWASP Security Tips for Designing Secured REST APIs

APIs are channels of communications, through which applications can “talk”. To create a connection between applications, REST APIs use HTTPS. HTTP requests pass through the API channel of communication and carry messages between applications. Threat actors target REST APIs because they’re after the data stored in HTTP requests. Threat »
4 Maturity Levels of REST API Design

4 Maturity Levels of REST API Design

If you are building REST APIs or REST Services you're using HTTP. Technically, REST services can be provided over any application layer protocol as long as they conform to certain properties. In practice, basically, everyone uses HTTP Protocol. Since we are discussing the creation of an API that »
REST API Error Handling - Problem Details Response

REST API Error Handling - Problem Details Response

I have been a REST API developer for many years and helped many companies to create APIs. One of the areas that are key to building a successful API is the error handling/response. Some time ago I wrote about the "REST API Error Handling Best Practices" which »
7 Rules for REST API URI Design

7 Rules for REST API URI Design

Before going over the rules for REST API URI design, let’s do a quick overview on some of the terms we are going to talk about. URIs REST APIs use Uniform Resource Identifiers (URIs) to address resources. On today’s web, URI designs range from masterpieces that clearly communicate »
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 »