You can specify the media type that is consumed by a REST API in two ways.
a. Using @Consumes annotation
@Consumes annotation specify the media types consumed by a particular component.
Example
@Post("/multiple1")
@Consumes({ MediaType.APPLICATION_FORM_URLENCODED, MediaType.APPLICATION_JSON })
public HttpResponse<Employee> create2(@Body final Employee employee) {
return HttpResponse.status(HttpStatus.CREATED).body(employee);
}
b. Using consumes attribute of http methods.
@Post(value = "/multiple2", consumes = {MediaType.APPLICATION_FORM_URLENCODED, MediaType.APPLICATION_JSON})
public HttpResponse<Employee> create3(@Body final Employee employee) {
return HttpResponse.status(HttpStatus.CREATED).body(employee);
}
Find the below working application.
Step 1: Create new maven project ‘micronaut-consume-media-type’.
Step 2: Update pom.xml with maven dependencies.
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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.sample.app</groupId>
<artifactId>micronaut-consume-media-type</artifactId>
<version>0.1</version>
<packaging>jar</packaging>
<parent>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-parent</artifactId>
<version>3.7.4</version>
</parent>
<properties>
<packaging>jar</packaging>
<jdk.version>11</jdk.version>
<release.version>11</release.version>
<micronaut.version>3.7.3</micronaut.version>
<micronaut.runtime>netty</micronaut.runtime>
<exec.mainClass>com.sample.app.App</exec.mainClass>
</properties>
<repositories>
<repository>
<id>central</id>
<url>https://repo.maven.apache.org/maven2</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-inject</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-validation</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-http-client</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-http-server-netty</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-jackson-databind</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>io.micronaut.test</groupId>
<artifactId>micronaut-test-junit5</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>io.micronaut.build</groupId>
<artifactId>micronaut-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<!-- Uncomment to enable incremental compilation -->
<!-- <useIncrementalCompilation>false</useIncrementalCompilation> -->
<annotationProcessorPaths
combine.children="append">
<path>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-http-validation</artifactId>
<version>${micronaut.version}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
</project>
Step 3: Define Employee model class.
Employee.java
package com.sample.app.model;
public class Employee {
private Integer age;
private String name;
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
Step 4: Define EmployeeController class.
EmployeeController.java
package com.sample.app.model;
public class Employee {
private Integer age;
private String name;
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
Step 5: Define main application class.
App.java
package com.sample.app;
import io.micronaut.runtime.Micronaut;
public class App {
public static void main(String[] args) {
Micronaut.run(App.class);
// Use this if you want the beans to be initialized eagerly
/*
* Micronaut.build(args) .eagerInitSingletons(true) .mainClass(App.class)
* .start();
*/
}
}
Total project structure looks like below.
Build the project using mvn package command.
Navigate to the folder where pom.xml is located and execute the command ‘mvn package’.
Upon command successful execution, you can see the jar file ‘micronaut-consume-media-type-0.1.jar’ in project target folder.
$ ls ./target/
classes
generated-sources
generated-test-sources
maven-archiver
maven-status
micronaut-consume-media-type-0.1.jar
original-micronaut-consume-media-type-0.1.jar
test-classes
Execute below command to run the application.
java -jar ./target/micronaut-consume-media-type-0.1.jar
Execute below commands to test the apis.
curl --location --request POST 'http://localhost:8080/employees' \
--header 'Content-Type: application/json' \
--data-raw '{
"age": 28,
"name": "Krishna"
}'
curl --location --request POST 'http://localhost:8080/employees/multiple1' \
--header 'Content-Type: application/json' \
--data-raw '{
"age": 28,
"name": "Krishna"
}'
curl --location --request POST 'http://localhost:8080/employees/multiple1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'age=28' \
--data-urlencode 'name=krishna'
curl --location --request POST 'http://localhost:8080/employees/multiple2' \
--header 'Content-Type: application/json' \
--data-raw '{
"age": 28,
"name": "Krishna"
}'
curl --location --request POST 'http://localhost:8080/employees/multiple2' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'age=28' \
--data-urlencode 'name=krishna'$curl --location --request POST 'http://localhost:8080/employees' \
> --header 'Content-Type: application/json' \
> --data-raw '{
> "age": 28,
> "name": "Krishna"
> }'
{"age":28,"name":"Krishna"}$
$
$
$curl --location --request POST 'http://localhost:8080/employees/multiple1' \
> --header 'Content-Type: application/json' \
> --data-raw '{
> "age": 28,
> "name": "Krishna"
> }'
{"age":28,"name":"Krishna"}$
$
$
$curl --location --request POST 'http://localhost:8080/employees/multiple1' \
> --header 'Content-Type: application/x-www-form-urlencoded' \
> --data-urlencode 'age=28' \
> --data-urlencode 'name=krishna'
{"age":28,"name":"krishna"}$
$
$
$curl --location --request POST 'http://localhost:8080/employees/multiple2' \
> --header 'Content-Type: application/json' \
> --data-raw '{
> "age": 28,
> "name": "Krishna"
> }'
{"age":28,"name":"Krishna"}$
$
$
$curl --location --request POST 'http://localhost:8080/employees/multiple2' \
> --header 'Content-Type: application/x-www-form-urlencoded' \
> --data-urlencode 'age=28' \
> --data-urlencode 'name=krishna'
{"age":28,"name":"krishna"}
You can download this application from this link.
No comments:
Post a Comment