Exploring the World of Web Development Part 4 - Write Rest APIs

By -

One of the main advantages of writing a back-end Application using Spring is that Spring has the ability to  make a dependency injection, make it modular and loose coupling, your code easily reusable and can be shared across different components or modules. Each class in Spring is called a component that promotes the Single Responsibility Principle. Each component in spring can be any type of Configuration, Controller, Model, Service, Repository, etc.

A. Step by step develop Rest API using Spring

Without further ado, we are now trying to develop our own first API, to supply a list of products and handle a contact form validation and storing the contact data, and then displaying the list of user submitted feedback. At this moment we are not gonna store any of the data in a Database server, we will store the data in Memory. We will learn about SQL database integration using Spring in the next tutorial.

First thing to do to create your Spring skeleton, you can download the Spring project skeleton using an online feature visit http://start.spring.io. 

  • Select Maven as Project type, Spring boot 2.7.x and Java 11 as the language
  • Choose the following dependencies

After you finish naming your project, then extract the zip file that contains the empty spring project skeleton. Open the folder using Intellij IDEA.

In the most common structure of Spring Application is consist of five different type of Components:

1. Configuration

Here’s an example of Spring configuration to allow CORS on certain web domains.

2. Controller

And we are beginning to create A rest API with an endpoint named “/products”.

3. Service

Looking at the above controller, we call a service to get all of the products, and here we write our first service using Spring.

4. Model

And finally we have to create a Model and Repository for object representation of a Product.

We use a Java library called lombok, so we don’t have to create Constructors, getters, and setters. Those will be automatically generated by Lombok.

5. Repository

A repository is a type of component that provides a higher-level interface. By using a JPA repository, you don’t have to implement a Query to database. Spring provides abstraction for save(), findById(), findAll(), deleteById(), etc.

Finally, you may need to test out your first Rest API application. If you are using Intellij you can press the run button, but if you want to run your Spring app on a terminal, you can do the following:

cd path/to/your-project
mvn spring-boot:run

And then using either Postman or open it on the Browser, open the http://localhost:8080/products.

B. Spring is very suitable for large-scale projects

In my web development career writing backend applications, like 99% I would only use Java and PHP. The two languages are widely used for the development of almost all of the REST API that I have been developing. On the Java side Spring is the framework of choice for almost all of my Rest API. Before that I used PHP alot, I used that CodeIgniter-3 framework. I have been using Symfony and Laravel, but only for very small projects, but a long time ago I have not been doing any PHP code anymore, so this tutorial will be conducted using Java and Spring framework.

For me, both Java and PHP have their own strengths and weaknesses, for projects that are not very complicated and if you want a simpler language to do simple things quicker, you can write your Rest API using PHP. And what you care about is how to finish your project quicker, optimisation is not your priority, you will do it later as you finally reach a maximum user your app can handle. IF you want to write a quick and simpler Rest API. Still you have plenty of options : Firebase, NodeJs, Go and Python. They have a similarity which is to write code in no time.

On the other hand Java is a popular choice for building robust and scalable REST APIs. Especially using Spring Framework, the spring offers a rich ecosystem which provides extensive support for API development. Because of the strong typing and strong object-oriented styles, it makes Java code much more maintainable, easy refactoring and has better support for modern IDE. When you talk about IDE, I recommend anyone to develop their code using Intellij IDEA, it is a very awesome tool for various software development, Java is the one that has major support for it.

I like the Spring framework although it is kind of not simple because there’s so many things to know, basically there are hundreds of  Spring Classes that you have to remember. But it helps me simplify the development process and promotes good software engineering practices. Like  I have described, you have to create the right structure for your project, because when your project grows, you create lots of Components that you have to remember where it is and what it is doing. 

Something that I thought of when it comes to the Core of Spring framework is the IoC container, this thing is the underlying mechanism that manages the creation and lifecycle of your components. And some other thing that is the joy of writing your back-end app with Spring is the easy data access using Spring Data, like example above with the Repository component, I basically don’t write anything to access and alter the database. Spring uses ORM and frameworks like Hibernate, not only for SQL based databases, it even supports NoSQL databases like MongoDB. 

I also like how easy it is to configure your app security. Spring Security is a Spring module that helps in guarding your application by providing security features like authentication for accessing certain API. We don’t have to worry about SQL injection or any kind of security threat to your application.

C. The full source code

Thank you for keeping up until this moment, now I am glad to share the full source code of the project we created above.

Stay tuned for the next tutorial about Database integration in Spring.

I am an experiences web developer, have a good problem-solving and deep understanding of software development principles. With comprehensive skill set in Java, PHP, Python, C and JavaScript. Able to do database thing like MySQL and Oracle. Along with expertise in frameworks like Spring, React, and Firebase. Have a solid understanding of software development methodologies, like Agile and Scrum. I applies best practices to ensure the development process is efficient and of the highest quality output.

Popular posts from this blog

Spring Kafka - how to use ReplyingKafkaTemplate send and reply synchronously

By -
Image
Microservice Spring with Apache Kafka Kafka is an asynchronous messaging queuing system, but when you have a case in your project that you need to have the result immediately from another service you can do that quite easily. Kafka from the client side produces a message to the server side, then waiting for the server to return back the message exactly what the client wants. It’s identified in the kafka header request named KafkaHeaders.CORRELATION_ID and a topic where the server should send. If the server side produces the same correlation id to the same topic in the request, then the client side will catch that message as its reply. Although you can work with kafka from a different framework and language other than Java and Spring. Here’s in this example i just specifically giving the example of sending and replying kafka messages using Spring Boot. The Project Overview The client-project will send a string message to the server-project over kafka, then the server-project wil
Read more

How To Connect SSH Using PEM Certificate On Windows

By -
Image
Usually you will need a pair of SSH username and password to connect to a remote server. But there's also another way to connect to the server via SSH but without password, just using a dot pem (example.pem) file. Here's how we usually do on Windows 1. Let’s SSH login using pem to confirm if it’s throwing error or the pem is fine, if error then we need to move to step 2 to fix it: ssh adam@10.0.0.123  -i server-cert.pem And here's the usual error that will throw if your pem file is not ready for SSH login. You need to follow the next step to make your pem certificate ready to login to your server via SSH. 2. Open Windows Explorer, then right-click on the pem file, then select "Properties". Navigate to the "Security" tab, and click "Advanced" 3. Disable inheritance 4. Delete all permissions, so it doesn’t have any permission 5. Now add you as the only only owner. By click button Add and then Select a principal, then Advanced. 6. On the showing p
Read more

ERROR 1348 Column Password Is Not Updatable When Updating MySQL Root Password

By -
Image
MySQL and MariaDB password As already mentioned in the title of this blog, this error message sometimes occurred when we are trying to update our root password database, either MySQL or MariaDB, The error says: ERROR 1348 (HY000): Column 'Password' is not updatable This is because if we use this SQL command to update our database root password, and it turn out to be Restricted by MySQL to use update on mysql database. UPDATE mysql.user SET Password=PASSWORD('1234') WHERE User='root'; The solutions for MySQL Error1348 So you can not update a user password using Update commands, to update the password, use ALTER commands instead. like the following. ALTER USER 'root'@'localhost' IDENTIFIED BY '1234'; And then you need to do the flush privileges to commit previous queries (that alter command above) into the system, simply do like this. flush privileges; So now you have your root with password 1234. Although it is recommended to
Read more

How To Create Spring Boot Project Using Netbeans

By -
Image
Spring Boot is program that you can use to develops Spring Framework easier, without the need of using so many hard to handle configuration. This tutorial, we are gonna create Spring Boot Application by using Netbeans IDE. You can of course create Spring Boot Appilcation on Netbeans, but it will be easier if just using plugin for Spring development in Netbeans, 1. Open Netbeans, click tools menu and click plugin. After plugin window opened, click tab Available Plugins and find the "Nb SpringBoot" plugin then install and activate the plugin. 2. After restarting the Netbeans IDE. Now you gonna be able to create a new project with Spring boot application. File > New Project > Under categories, choose Maven > then choose  Spring Boot Basic. Now you can start the development of spring boot application using your Netbeans IDE. Open pom.xml to add spring boot dependencies you want.
Read more

Upload and Download Rest API using Spring Boot Reactive WebFlux

By -
Image
Reactive Spring Logo This is maybe a very simple task, but for those of you that may not be familiar with WebFlux found it difficult to create a Rest API that handles upload and download in Reactive spring application. Create the skeleton Spring project Create a new project, go to start.spring.io , on the dependencies section, add Spring Reactive Web. Generate and extract it into your desired project location. Instead of using spring-boot-starter-web, use spring-boot-starter-webflux instead in your pom.xml. Here’s the pom.xml for our Reactive Rest API project. Create our Rest controller Now that you have set to use WebFlux instead of the usual web, we have to change a little bit in the Controller class that handles the API endpoints. It doesn’t change much but you have to wrap the Response in Mono and the request parameter to FilePart. So our upload and download file controller will look like this. Create utility to handle file upload We need to structure our project better, so we cr
Read more