Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

Spring Boot Example with Camel REST DSL and OpenApi

Introduction

This example illustrates how to use Spring Boot with Camel. It provides a simple REST service that is created with Camel REST DSL and documented with OpenApi. Additionally, it provides a Swagger UI, through Springdoc, to easily interact with your REST API.

The project uses the camel-spring-boot-starter dependency, a Spring Boot starter dependency for Camel that simplifies the Maven configuration.

The project also uses camel-servlet component as the HTTP transport component for Camel REST DSL.

Build

You can build this example using:

$ mvn package

Run

You can run this example using:

$ mvn spring-boot:run

After the Spring Boot application is started, you can open the following URL in your web browser to access the REST endpoint and retrieve a list of users: http://localhost:8080/api/users

To use the Swagger UI, open http://localhost:8080/swagger-ui.html

You can also access the REST endpoint from the command line:

$ curl http://localhost:8080/api/users

The command will produce the following output:

[ { "id" : 1, "name" : "John Coltrane" }, { "id" : 2, "name" : "Miles Davis" }, { "id" : 3, "name" : "Sonny Rollins" } ]

The OpenApi documentation is located at: http://localhost:8080/api/api-doc and can be retrieved with the following command:

$ curl http://localhost:8080/api/api-doc

The Spring Boot application can be stopped pressing [CTRL] + [C] in the shell.

Help and contributions

If you hit any problem using Camel or have some feedback, then please let us know.

We also love contributors, so get involved :-)

The Camel riders!