Merge pull request #2 from tutorialworks/renovate/camel.version

Update dependency org.apache.camel.springboot:camel-spring-boot-dependencies to v3.19.0

Author: monodot

README.md

@@ -1,16 +1,20 @@
-# Camel Sports API (JSON in REST services)
+# Using JSON in REST services in Apache Camel
 
-This is a demo that shows how to use Apache Camel on Spring Boot to expose a REST service.
+This is a demo that shows how to use Apache Camel on Spring Boot to expose a REST service with JSON payloads.
 
-It also shows how to use Camel's _REST binding mode_ to automatically convert Java POJOs to JSON in the response. JSON support is provided by the `camel-jackson-starter` dependency.
+It shows how to use Camel's _REST binding mode_ to automatically convert POJOs (Plain Old Java Objects) into JSON in the response. In Camel, JSON support is provided by the `camel-jackson-starter` dependency.
 
 For more info, check out the accompanying YouTube video and blog post!
 
-- [Video: Adding JSON to my REST API (YouTube)][youtube]
+- [Video: Adding JSON to my REST API (YouTube)][youtube] - This example has been slightly modified (some might say improved!) from the YouTube video.
 - [Blog: Create a REST service in Apache Camel (tomd.xyz)][blog]
 
+And for more tutorials check out <https://www.tutorialworks.com>.
+
 ## To run
 
+You'll need [Apache Maven][maven] installed. Then run:
+
     mvn clean spring-boot:run
 
 And the service will be accessible at:
@@ -19,17 +23,65 @@ And the service will be accessible at:
 
 ## To test
 
-To test with `curl`:
+You can use an API testing tool like `curl` to test the GET operation of the service:
+
+```bash
+curl http://localhost:8080/services/go-sports
+```
+
+Which should return a response like this, showing all the sports in the repository. You can format the output nicely using a tool like [jq][jq]:
+
+```json
+[
+  {
+    "name": "American Football",
+    "players": 11,
+    "league": "NFL"
+  },
+  {
+    "name": "Basketball",
+    "players": 5,
+    "league": "NBA"
+  },
+  {
+    "name": "Baseball",
+    "players": 9,
+    "league": "MLB"
+  },
+  {
+    "name": "Volleyball",
+    "players": 6,
+    "league": "NVA"
+  }
+]
+```
+
+To add a new Sport to the database with `curl`, send a POST request:
 
-    curl -H 'Content-Type: application/json' -X POST --data '{ "name": "Sportsball" }' http://localhost:8080/services/go-sports
+    curl -H 'Content-Type: application/json' -X POST --data '{ "name": "Football", "players": 11, "league": "Premier League" }' http://localhost:8080/services/go-sports
 
-If you're using another REST testing tool like Insomnia, just make sure it includes the header `Content-Type: application/json` in the request.
+If you're using another REST testing tool like [Insomnia][insomnia], make sure that it includes the header `Content-Type: application/json` in the request.
 
-## Changing the URL
+## Changing the base API URL
 
-If you don't like `/services/` and you want to change the root URL used for all Camel servlet endpoints (e.g. REST services) then edit this line in `application.properties`:
+If you don't like `/services/` and you want to change the root URL used for all Camel servlet endpoints (which includes REST services like this one) then edit this line in `application.properties`:
 
-    camel.component.servlet.mapping.context-path=/services/*
+    camel.servlet.mapping.context-path=/services/*
+
+## That's it!
+
+That's all there is to it. You can now use the REST service to add and retrieve sports in JSON format.
+
+We're keeping it simple here, using a simple Java object to store the sports. But in real usage you might swap out the `SportRepository` class with a different class to store and retrieve the data from a database.
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See the [LICENSE][license] file for more info.
 
 [youtube]: https://www.youtube.com/watch?v=YpVVXDnZLPo
 [blog]: https://tomd.xyz/camel-rest/
+[maven]: https://maven.apache.org/
+[jq]: https://stedolan.github.io/jq/
+[insomnia]: https://insomnia.rest/
+[license]: LICENSE
+

pom.xml

@@ -13,7 +13,7 @@
 
 	<properties>
 		<java.version>11</java.version>
-		<camel.version>3.9.0</camel.version>
+		<camel.version>3.19.0</camel.version>
 		<spring.boot-version>2.4.4</spring.boot-version>
 
 		<maven.compiler.source>1.8</maven.compiler.source>

src/main/java/com/tutorialworks/camel/sportsapi/CamelSportsRouteBuilder.java

@@ -4,11 +4,15 @@
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.model.rest.RestBindingMode;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
 @Component
 public class CamelSportsRouteBuilder extends RouteBuilder {
 
+    @Autowired
+    SportRepository sportRepository;
+
     @Override
     public void configure() throws Exception {
         restConfiguration()
@@ -19,15 +23,20 @@ public void configure() throws Exception {
                 .path("/go-sports")
 
                 .get()
-                    .route()
-                    .transform(simple("I'm your resource " +
-                                "for all the sports!"))
-                .endRest()
+                    .to("direct:getSports")
 
                 .post()
                     .type(Sport.class)
                     .outType(SportResponse.class)
-                    .route()
+                    .to("direct:postSport");
+
+
+        from("direct:getSports")
+                // Get all the sports from the repository
+                // Camel will marshal to JSON automatically!
+                .bean(sportRepository, "getSports");
+
+        from("direct:postSport")
                     .to("log:mylogger?showAll=true")
 
                     // An inline processor to generate the response
@@ -37,16 +46,18 @@ public void process(Exchange exchange) throws Exception {
                             // Get the Body as an (unmarshalled!) Sport POJO
                             Sport sport = exchange.getMessage().getBody(Sport.class);
 
+                            sportRepository.addSport(sport);
+
                             // Build up the response using our SportResponse class
                             SportResponse response = new SportResponse();
                             response.setMessage("Thanks for submitting "
                                     + sport.getName());
 
                             // Pop the response back in the body
+                            // Camel will marshal to JSON automatically!
                             exchange.getMessage().setBody(response);
                         }
-                    })
-                .endRest();
+                    });
     }
 
 }

src/main/java/com/tutorialworks/camel/sportsapi/Sport.java

@@ -3,8 +3,17 @@
 public class Sport {
 
     private String name;
-    private int teamMembers;
-    private String venue;
+    private int players;
+    private String league;
+
+    public Sport() {
+    }
+
+    public Sport(String name, int players, String league) {
+        this.name = name;
+        this.players = players;
+        this.league = league;
+    }
 
     public String getName() {
         return name;
@@ -14,19 +23,28 @@ public void setName(String name) {
         this.name = name;
     }
 
-    public int getTeamMembers() {
-        return teamMembers;
+    public int getPlayers() {
+        return players;
+    }
+
+    public void setPlayers(int players) {
+        this.players = players;
     }
 
-    public void setTeamMembers(int teamMembers) {
-        this.teamMembers = teamMembers;
+    public String getLeague() {
+        return league;
     }
 
-    public String getVenue() {
-        return venue;
+    public void setLeague(String league) {
+        this.league = league;
     }
 
-    public void setVenue(String venue) {
-        this.venue = venue;
+    @Override
+    public String toString() {
+        return "Sport{" +
+                "name='" + name + '\'' +
+                ", players=" + players +
+                ", league='" + league + '\'' +
+                '}';
     }
 }

src/main/java/com/tutorialworks/camel/sportsapi/SportRepository.java

@@ -0,0 +1,30 @@
+package com.tutorialworks.camel.sportsapi;
+
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+
+@Component
+public class SportRepository {
+
+    private List<Sport> sports;
+
+    public SportRepository() {
+        sports = new ArrayList<>();
+        sports.add(new Sport("American Football", 11, "NFL"));
+        sports.add(new Sport("Basketball", 5, "NBA"));
+        sports.add(new Sport("Baseball", 9, "MLB"));
+        sports.add(new Sport("Volleyball", 6, "NVA"));
+
+    }
+
+    public List<Sport> getSports() {
+        return sports;
+    }
+
+    public void addSport(Sport sport) {
+        sports.add(sport);
+    }
+
+}

src/main/resources/application.properties

@@ -1,4 +1,4 @@
 
 
 # Modify this line if you want to change the root URL of the Camel servlet
-camel.component.servlet.mapping.context-path=/services/*
+camel.servlet.mapping.context-path=/services/*