DEV Community

realNameHidden
realNameHidden

Posted on

1 1 1 1 1

How to read Query Param in Spring Boot

Create Project with Spring Web Dependency
Directory Structure:

Image description

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.4.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>QueryParam</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>QueryParam</name>
    <description>Demo project for Spring Boot</description>
    <url/>
    <licenses>
        <license/>
    </licenses>
    <developers>
        <developer/>
    </developers>
    <scm>
        <connection/>
        <developerConnection/>
        <tag/>
        <url/>
    </scm>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Enter fullscreen mode Exit fullscreen mode

GreetingController

package com.example.demo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GreetingController {

 @GetMapping("/greet")
 public String greetUser(@RequestParam String name,@RequestParam(required = false,defaultValue = "User")String title) {
  return "Hello "+title+" "+name+"!";
 }

}

Enter fullscreen mode Exit fullscreen mode

Hit the Endpoint
URL with Query Parameters:

http://localhost:8080/greet?name=John&title=Mr

Output

Hello Mr John!

Explanation

@RequestParam String name: Marks name as a required query parameter.

@RequestParam(required = false, defaultValue = "User") String title: Makes title optional and assigns a default value if not provided.

Top comments (0)