Designing REST API - What is Contract First?

Image Image

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?

Free Courses - Learn in 10 Steps


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.


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


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

Best Selling Udemy Courses

Image Image Image Image Image Image Image Image Image Image Image Image

Join 450,000 Learners and 30+ Amazing Courses

350,000 Learners are learning everyday with our Best Selling Courses : Spring Boot Microservices, Spring, Spring Boot, Web Services, Hibernate, Full Stack React, Full Stack Angular, Python, Spring Interview Guide, Java Interview, Java Functional Programming, AWS, Docker, Kubernetes, PCF, AWS Fargate and Azure

Do not know where to start your learning journey? Check out our amazing learning paths:
Learning Path 01 - Spring and Spring Boot Web Applications and API Developer,
Learning Path 02 - Full Stack Developer with Spring Boot, React & Angular,
Learning Path 03 - Cloud Microservices Developer with Docker and Kubernetes,
Learning Path 04 - Learn Cloud with Spring Boot, AWS, Azure and PCF and
Learning Path 05 - Learn AWS with Microservices, Docker and Kubernetes



Related Posts

Understanding jwt token

Let us understand the json web tokens

Single sign-on workflow

Let us understand the single sign-on workflow

Oauth2.0 - Resource Owner Password Credentials grant workflow

Let us understand the Oauth2.0 Resource Owner Password Credentials grant workflow

Oauth2.0 - Implicit grant workflow

Let us understand the Oauth2.0 implicit grant workflow

Oauth2.0 - Client Credentials grant workflow

Let us understand the Oauth2.0 client credentials grant workflow

Oauth2.0 - Authorization grant workflow

Let us understand the Oauth2.0 authorization grant workflow

Writing Integration Tests for Rest Services with Spring Boot

Setting up a basic REST Service with Spring Boot is a cake walk. We will go one step further and add great integration tests!

Integrating Spring Boot and Spring JDBC with H2 and Starter JDBC

Learn using Spring Boot Starter JDBC to connect Spring Boot to H2 (in memory database) using Spring JDBC. You will create a simple project with Spring Boot. You will add code to the project to connect to a database using Spring JDBC. You will learn to implement the basic CRUD methods.

JUnit Tutorial for Beginners in 5 Steps

JUnit Tutorial for Beginners in 5 Steps. Setting up a basic JUnit example and understanding the basics of junit.

JPA and Hibernate Tutorial For Beginners - 10 Steps with Spring Boot and H2

JPA and Hibernate in 10 Steps with H2 - Setting up a basic project example with Spring Boot and in memory database H2. Its a cake walk.