Getting Started
New to Juneau? Work through these four short pages in order. They build one small project, a Pet
bean, a REST resource that serves it, and a client that calls it, and every code block is complete enough to
compile and run as shown.
Before you start
| You need | Notes |
|---|---|
| JDK 17 or newer | java -version |
| Apache Maven 3.9 or newer | mvn -version |
| An empty directory | The walkthrough creates pom.xml and four small source files in it. |
| Port 10000 free | Page 3 starts a web server there (Ports used in these docs). |
| About 10 minutes | The Maven commands themselves run in seconds. The first build is slower because Maven downloads the Juneau modules and Jetty. |
Juneau 10 is a pre-release (10.0.0-SNAPSHOT), so the project resolves it from the Apache snapshots
repository. Page 1 sets that up for you.
- Install Juneau: create the project and its
pom.xml. - Your first serializer: turn a bean into JSON and back.
- Your first REST app: expose a bean over HTTP.
- Your first client: call it with the REST client.
Prefer to start from a working project?
The walkthrough above does not need them. The Starter Projects are clone-and-go "Hello World" apps for Jetty, Spring Boot, and Tomcat. The Petstore is a fuller showcase, and the Examples cover marshalling and MCP.
Coming from Juneau 9?
Read the V10 Migration Guide first. It has the module, package, and API rename tables. If you use the REST client, also see Choosing a REST Client.
Where to go next
- Guides: task-based walkthroughs, from a Spring Boot API to a typed client.
- Ecosystem Overview: every module and what it requires.
- Dependency Management: the BOM and the bundles.
- Why Choose Juneau? and Framework Comparisons.