Designing REST API - What is Contract First?


Designing Great REST API is important to have great microservices. Contract First approach helps you in designing a great contract before implementing it. However, it does not come easy!

You will learn

  • What is Contract First approach of designing REST API?
  • What are advantages of Contract First approach?
  • What are disadvantages of Contract First approach?
  • When do you adopt Contract First approach?

REST API

This is the third article in a series of articles on REST APIs:

Understanding Web Services

There are several kinds of web services that are offered - REST, SOAP - among others.

For every services, there is a

  • The service provider, which provides the service
  • The service consumer, which makes use of it

A consumer needs to know the details of the service provided. For this reason, a contract needs to be in place. A service contract specifies:

  • What are the inputs and the outputs of/from the service?
  • What is the URL at which the service is available?
  • How do you send authorization?

Contract First Approach

In a Contract-First approach, you first define the contract, and then implement the service.

Let’s look at an example.

WSDL

Let us first take up the case of WSDL - Web Service Definition Language format. Here is an example in use:

image info

WSDL is typically used with SOAP/XML web services. In such a definition, you typically define:

  • The formats of the request and response

image info

  • Where the services are exposed

image info

  • The URL where the serviced can be called

image info

  • The headers that are part of the request

What Contract-First Implies

When we start out with establishing a contract, we define a WSDL, and then share it with our consumer. All this can happen even before we implement the service and make it available.

The contract tells the consumer what the request and response communication is expected to be. Once the contract is in place, the service provider can work on providing a service that adheres to the contract. The service consumer can work on developing an application to consume it.

Advantages Of Contract First

Teams Can Develop In Parallel

Since coding happens based on the contract, the service provider and service consumer teams are clear about the communication approach and details. Hence, development can happen at the same time.

Teams Know What To Expect

Since coding happens based on contract, the producer and consumer teams have an idea of each others’ expectations. As a result, if cross team testing is not possible due to different pace of development, stub software can be used to mock the others behavior, all based on the contract.

Cross Platform Compatible

Once the service parameters depend only on the contract, the actual software framework used to develop the service does not matter that much. The service provider and service consumer can use different technologies.

Enables Reuse Of Schemas

The schemas that are used to define the contract for a service, are well defined in the WSDL. Therefore, if parts of services are repeated across other services, then the corresponding schemas can be reused as well.

Disadvantages Of Contract First

Requires Initial Additional Effort

Most of this effort would center round agreement on a service contract. You need to make sure that the contract is well defined and does not change very often.

Mechanism For Contract Update And Sharing

Over the course of using a service, if you update a contract, it affects all the other stakeholders. Therefore, there has to be a proper mechanism to communicate the changes to the various consumers.

Do check out our video on this:

image info

Summary

In this article, we discussed about the Contract-First approach, in the context of web services.

10 Step Reference Courses

Image Image Image Image Image

in28Minutes is helping 300,000 Learners across the world reach their learning goals. Click here for the complete catalogue of 30 Courses.

Related Posts

Spring Boot Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. This resources will help you learn and gain expertise at Spring Boot.

Spring and Spring Boot Video Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. Here's a list of video tutorials and courses for you

Software Design - Separation Of Concerns - with examples

Software architects and programmers love having Seperation of Concerns. What is it? Why is it important? Let's get started.

Object Oriented Software Design - Solid Principles - with examples

Software design is typically complex. Object oriented design takes it to the next level. There are a number of design patterns and other stuff to be aware of. Can we make things simple? What are the goals to aim for when you are doing object oriented design? SOLID Principles is a great starting point for Object Oriented Design.

Software Design - Open Closed Principle - with examples

Open Closed Principle is one of the SOLID Principles. You want your code to be easily extended. How do you achieve it with minimum fuss? Let's get started.

Software Design - What is Dependency Inversion Principle?

Dependency Inversion Principle is one of the important SOLID Principles. Dependency Inversion Principle is implemented by one of the most popular Java frameworks - Spring. What is it all about? How does it help you design good applications?

Introduction to Four Principles Of Simple Design

With agile and extreme programming, the focus is on keeping your design simple. How do you keep your design simple? How do you decide whether your code is good enough?

Software Design - Single Responsibility Principle - with examples

For me, Single Responsibility Principle is the most important design principle. What is Single Responsibility Principle? How do you use it? How does it help with making your software better? Let's get started.

REST API Best Practices - With Design Examples from Java and Spring Web Services

Designing Great REST API is important to have great microservices. How do you design your REST API? What are the best practices?

Designing REST API - What is Code First Approach?

Designing Great REST API is important to have great microservices. Code First approach focuses on generating the contract from code. Is it the best possible approach?