How to create simple restful web services with spring security using Spring Boot.
Table Of Contents
Prerequisites:
- Java JDK 1.8
- IDE
Introduction:
In this tutorial, we are going to create simple restful web services with spring security included. We are using spring boot scaffolding mechanism, from which we can simply generate the application prototype with its project structure. Simply visit start.spring.io here.
We are using maven project with java and spring boot 2.1.1 with dependencies Web, Security and DevTools.
Generate Project and extract it and open with your favorite Ide. It may take some time to download selected dependencies.
We are using maven project with java and spring boot 2.1.1 with dependencies Web, Security and DevTools.
Generate Project and extract it and open with your favorite Ide. It may take some time to download selected dependencies.
Project Structure:
Here, inside LearntocodeApplication.java there is the main method which will run spring boot application. As we have already added spring boot starter like "Web" inside dependencies section so it has autoconfiguration for tomcat and other feature configuration for running the application.
Make sure required dependencies are in pom.xml file.
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-security</artifactid>
</dependency>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-web</artifactid>
</dependency>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-devtools</artifactid>
<scope>runtime</scope>
</dependency>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-test</artifactid>
<scope>test</scope>
</dependency>
<dependency>
<groupid>org.springframework.security</groupid>
<artifactid>spring-security-test</artifactid>
<scope>test</scope>
</dependency>
Run the application:
In order to run your application you can simply run via your editor or via command line. If you are trying to run via command line simply go to project's root directory and type the following command in your terminal.
mvn spring-boot:run
Using generated security password: 0fbaa489-e991-4920-a84d-a9710741c378
Create End Point:
In order to test our application, we need to create some Controller with a specified endpoint.
HelloController.java
HelloController.java
package com.example.learntocode.restTest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
@GetMapping("/")
public String hello(){
return "Hello";
}
}
Test:
I am using postman for a testing endpoint. If we hit endpoint "http://localhost:8080" with Get request we will get Unauthorized message as follows.
Now lets test with the credential provided by spring security as discussed above with generated password.
Note: The default username is "user" and password is generated one. It will generate a new password for each time when we run our application.
Here we have successfully secured our application.
In order to customize the username and password go to "application.properties" and configure as follows.
spring.security.user.name=yourUserName
spring.security.user.password=yourPassword
