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?

You will learn

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


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

What Is Code First?

Whenever you develop service, such as a REST API or a SOAP API, there are two approaches you could choose from:

  • Code First, and generate the contract out of the code
  • Contract First, and develop the code based on the contract

Let’s start with a quick example for Code First

Spring Boot Code First REST API Example

We are developing a RESTful web service, by making use of the Spring Boot Framework to generate the API. For example, in the retrieveAllUsers() API, we expose the "/users" URI and return all the user resources by calling a service method. when we hit this URL, we get these users returned:

image info

In a similar manner, there are other service methods defied, each with their own URI. What we are doing with this example is taking the code, and generating documentation from it. That documentation lists out how a user can use the service. For this, we use a documentation format called Swagger:

image info

Swagger enables us to generate documentation from the code. For example, the following is what Swagger generates for a request to retrieve all users:

image info

It lists out the kind of response message we get, and the response status accompanying it as well. You can even call that service from Swagger, leading to:

image info

You can also send a POST request to "/users":

image info

Swagger tells us how to structure the request message, and specify the individual field formats inside. It will also tell you the type of response you get back, along with the response code.

What Swagger generates out of the code, is called a contract.

Advantages Of Code First

The advantages of this approach are mainly:

  • Low-effort contracts: Generating the contract does not require any additional effort. It is just a by-product of the service development, as it can be automatically generated from the code
  • Contract, code in-sync: As the contract is generated from the code, the two always in sync with each other

Disadvantages Of Code-First

The disadvantages of this approach are as follows:

No Parallel Development

The service producer and the service consumers cannot be developed in parallel. First the service needs to be developed, then the contract is generated, and only after that, consumer code can be written to adhere to the contract. Without understanding the contract, a consumer cannot be developed.

No Target For Teams

As the contract cannot be known before the service is developed, there is no target for the various stakeholders in development. Hence, there is every chance that directions go wayward, and unnecessary changes are made, leading to wastage of effort.

No Cross-Platform Compatibility

In some older frameworks, it is not that easy to generate the contract from the code. As a result, it is quite common for the contracts generated not being compatible across platforms.

Do check out our video on this:

image info


In this article, we explored the code first approach of building REST API. While code first approach is efficient from a developer perspective, it has significant challenges when it comes to developing the service provider and consumer together.

10 Step Reference Courses

Image Image Image Image Image

in28Minutes is creating amazing solutions for you to learn full stack and the cloud - Docker, Kubernetes, AWS, React, Angular etc. 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 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!