Scribd
Upload
178 views

Build Java Rest API

This document provides a step-by-step guide to developing and building a Java REST API with Spring Boot, including prerequisites like Java, Eclipse IDE, Spring Boot, H2 database, JUnit 5, Maven, and Postman. It explains how to create a simple TODO API for getting task lists and creating new tasks using GET and POST requests respectively. The document then outlines the project structure, features like auto-restart, production readiness, repositories, controllers, testing, documentation, and deployment.

Uploaded by

Athar Riaz
Copyright
© © All Rights Reserved
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
178 views

Build Java Rest API

This document provides a step-by-step guide to developing and building a Java REST API with Spring Boot, including prerequisites like Java, Eclipse IDE, Spring Boot, H2 database, JUnit 5, Maven, and Postman. It explains how to create a simple TODO API for getting task lists and creating new tasks using GET and POST requests respectively. The document then outlines the project structure, features like auto-restart, production readiness, repositories, controllers, testing, documentation, and deployment.

Uploaded by

Athar Riaz
Copyright
© © All Rights Reserved
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
You are on page 1/ 2

How To Develop and Build Java Rest API

A step by step guide with an example project


Bhargav Bachina
Bhargav Bachina
Apr 8, 2020 · 10 min read
Photo by Christoph Theisinger on Unsplash

REST is an acronym for REpresentational State Transfer. Rest follows some


guidelines to facilitate the communication between systems. This article list out
all the necessary ingredients for the production-ready Java rest API with an
example project.

Let’s not complicate things and create a simple todo API where you get a list of
tasks with Get request and create a task with the post request. since we are
focussing on the Java REST API, let’s go with the simple API.

Prerequisites
Example Project
Start With Spring Initializer
Configure H2 Database
Understanding Project Structure
Auto Restart and Live Reload With Spring Dev Tools
Production-Ready Features With Spring Actuator
Create Repository With Spring Data Rest
Controller, Spring HATEOAS and Exception Handling
Testing the URLs With Postman
Unit Testing With JUnit 5
Integration Testing With Rest Assured
Code Coverage
Swagger Documentation
Dockerize The API
Best Practices
Conclusion

Prerequisites

Here are the prerequisites for this article. If you don’t have these on your system
go ahead and install them if you want to practice on your machine.

Java
Eclipse IDE
Spring Boot
H2 Database
JUnit 5
Maven
JMeter
Project Lombok
Postman

Java Runtime and SDK: We need java runtime and SDK for the Java applications to
run. This is the core component for running Java applications.

Eclipse IDE: We need an IDE to develop this application. There are other IDEs such
as NetBeans, IntelliJ IDE, etc. Eclipse is an open-source IDE and has very good
community support.

Spring Boot: Spring is a framework that makes our life easy to develop these java
based applications. Spring Boot makes it easy to create stand-alone, production-
grade Spring based Applications that you can “just run”.
H2 Database: H2 Database is a very fast, open-source, JDBC API, and in-memory
database. We use this as a database for our project.

JUnit 5: JUnit 5 is the testing framework for Java applications.

Maven: We need Maven to install dependencies, package, and build the project.

JMeter: It’s open-source software that is designed for load testing functional
behavior and measures the performance of the application.

Project Lombok: This is a java library that automatically plugs into your editor
and builds tools, spicing up your java. You would never write another getter or
equals method again, with one annotation your class has a fully-featured builder,
Automate your logging variables, and much more.

Postman: Manual testing your APIs

You might also like