-
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 2 commits
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
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,60 @@ | ||
| ##WebServer Basic Example | ||
|
|
||
| This example demonstrates a minimal Helidon WebServer application that starts an HTTP server and exposes simple routes. | ||
|
|
||
| ##Project Structure | ||
|
|
||
| ``` | ||
| webserver-basic/ | ||
| ├── src | ||
| │ └── main | ||
| │ └── java | ||
| │ └── io/helidon/examples/webserver/basic/ | ||
| │ ├── Main.java | ||
| │ └── GreetService.java | ||
| ├── pom.xml | ||
| └── README.md | ||
|
|
||
romain-grecourt marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
| ##Build | ||
|
|
||
| Use Maven to compile the project: | ||
|
|
||
| mvn clean install | ||
romain-grecourt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Run | ||
|
|
||
| Start the WebServer using: | ||
|
|
||
| java -jar target/webserver-basic.jar | ||
romain-grecourt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| The server will start on the default port (8080) unless configured otherwise. | ||
|
|
||
| Exercise the Application | ||
|
|
||
| After the application is running, you can call the available endpoints: | ||
|
|
||
| Root endpoint | ||
| curl -X GET http://localhost:8080 | ||
romain-grecourt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Greet endpoint | ||
| curl -X GET http://localhost:8080/greet | ||
romain-grecourt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Personalized greeting | ||
| curl -X GET http://localhost:8080/greet/{name} | ||
romain-grecourt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| This will return: | ||
| {"message": "Hello {name}!"} | ||
romain-grecourt marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Update the greeting | ||
| curl -X PUT -H "Content-Type: application/json" \ | ||
romain-grecourt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| -d '{"greeting": "Hola"}' \ | ||
| http://localhost:8080/greet/greeting | ||
|
|
||
| ##Notes | ||
|
|
||
| This example follows the standard Helidon project layout. | ||
|
|
||
| For more advanced server features, refer to other examples in the repository. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need spaces after the
#.See