-
Notifications
You must be signed in to change notification settings - Fork 31
Add README and improve documentation for WebServer basic example #215
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
NA-V10
wants to merge
3
commits into
helidon-io:dev-4.x
Choose a base branch
from
NA-V10:improve-basic-webserver-example
base: dev-4.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| 🚀 Helidon WebServer – Basic Example | ||
|
|
||
| This example demonstrates the simplest possible Helidon SE WebServer application. | ||
| It shows how to start a server, define basic routing, handle HTTP requests, and return responses. | ||
|
|
||
| This is a good starting point for understanding how Helidon SE applications are structured. | ||
|
|
||
| 📂 Project Structure | ||
| basic/ | ||
| ├── pom.xml | ||
| └── src | ||
| ├── main | ||
| │ ├── java/io/helidon/examples/webserver/basic/BasicMain.java | ||
| │ └── resources/logging.properties | ||
| └── test | ||
| └── java/io/helidon/examples/webserver/basic/ | ||
| ├── AbstractBasicRoutingTest.java | ||
| ├── BasicRoutingIT.java | ||
| └── BasicRoutingTest.java | ||
|
|
||
| 🧠 What This Example Shows | ||
| ✔ Start a WebServer | ||
|
|
||
| The example configures and starts a Helidon SE WebServer on a selected port. | ||
|
|
||
| ✔ Define Basic Routing | ||
|
|
||
| It demonstrates simple routing, including: | ||
|
|
||
| Returning plain text responses | ||
|
|
||
| Handling HTTP GET endpoints | ||
|
|
||
| Using routing builders | ||
|
|
||
| ✔ Logging Configuration | ||
|
|
||
| logging.properties shows how Helidon configures Java Util Logging (JUL). | ||
|
|
||
| ✔ Tests Included | ||
|
|
||
| The example contains: | ||
|
|
||
| Unit tests | ||
|
|
||
| Integration tests (running an actual WebServer instance) | ||
|
|
||
| These tests help verify routing behavior automatically. | ||
|
|
||
| ▶️ How to Run | ||
| Using Maven | ||
|
|
||
| From the basic directory: | ||
|
|
||
| mvn package | ||
| java -jar target/basic.jar | ||
|
|
||
|
|
||
| Server starts on the default port (usually 8080). | ||
|
|
||
| You will see output like: | ||
|
|
||
| WEB server started at http://localhost:8080 | ||
|
|
||
| 🔗 Example Endpoints | ||
|
|
||
| Once the server is running, try: | ||
|
|
||
| GET /greet | ||
| curl http://localhost:8080/greet | ||
|
|
||
|
|
||
| Response: | ||
|
|
||
| Hello World! | ||
|
|
||
|
|
||
| If routing includes path parameters, you may also test: | ||
|
|
||
| GET /greet/{name} | ||
| curl http://localhost:8080/greet/Naveen | ||
|
|
||
|
|
||
| Example response: | ||
|
|
||
| Hello Naveen! | ||
|
|
||
| 🧪 Run Tests | ||
| mvn test | ||
|
|
||
|
|
||
| This executes both: | ||
|
|
||
| Unit tests | ||
|
|
||
| Integration tests (start WebServer and verify responses) | ||
|
|
||
| 📘 Useful to Learn | ||
|
|
||
| This example helps new users understand: | ||
|
|
||
| How to create a minimal Helidon SE service | ||
|
|
||
| How routing works | ||
|
|
||
| How requests and responses are handled | ||
|
|
||
| How Helidon SE applications are structured | ||
|
|
||
| How to write integration tests for WebServer applications | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.