-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Documentation for Custom http status code #11445
Open
Nitishrajj
wants to merge
3
commits into
micronaut-projects:4.7.x
Choose a base branch
from
Nitishrajj:patch-1
base: 4.7.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 all 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 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,38 @@ | ||
The Micronaut framework supports custom HTTP status codes. This feature enables developers to define and use HTTP status codes beyond the standard ones, allowing integration with systems or APIs that rely on non-standard status codes. | ||
=== Custom HTTP Status Codes | ||
Micronaut supports arbitrary HTTP status codes that are not part of the predefined `HttpStatus` enum. Developers can specify any valid HTTP status code within the range `100-599`. | ||
|
||
==== Usage | ||
- `HttpResponse.status(int statusCode)`: | ||
Allows setting a custom HTTP status code. | ||
- `HttpResponse.status(int statusCode, String reason)`: | ||
Allows setting a custom HTTP status code along with a reason phrase. | ||
|
||
Below we can see how we support custom status codes and how to implement them. | ||
|
||
snippet::io.micronaut.http.HttpResponse[tags="getStatusMethod", indent=0, title="HttpResponse.java"] | ||
Let's start with a simple example. Given the following class: | ||
|
||
snippet::io.micronaut.http.client.netty.FullNettyClientHttpResponse[tags="getBodyMethod", indent=0, title="FullNettyClientHttpResponse.java"] | ||
Note how we use code() in the condition where we are checkimg custom http status code. | ||
|
||
snippet::io.micronaut.http.client.InvalidStatusSpec[tags="testInvalidStatus", indent=0, title="InvalidStatusSpec.groovy"] | ||
This snippet includes a test for handling an invalid HTTP status code in a Micronaut application. | ||
|
||
=== Client Response Handling | ||
The HTTP client in Micronaut can process custom status codes returned by servers. Custom codes are treated appropriately based on their range: | ||
- Codes `<400` are treated as successful responses. | ||
- Codes `>=400` trigger exceptions. | ||
|
||
==== Example | ||
[source,java] | ||
---- | ||
try { | ||
HttpResponse response = httpClient.toBlocking().exchange("/example"); | ||
int statusCode = response.code(); | ||
} catch (HttpClientResponseException e) { | ||
if (e.code() == 450) { | ||
// Handle custom status code | ||
} | ||
} | ||
---- |
This file contains 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
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.
Have you tested these snippets actually work?