Mixing
Swagger @ApiParam require not working when null is passed
I have the following:
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Path("/some/path")
void createSomething(@ApiParam(required = true) @Valid final User user);
And User is something like
class User {
@Valid
@NotNull
@NotBlank
final String name;
...
}
I do get back 400 if I do curl -X POST -H "Content-Type: application/json" /some/path -d '{"foo":"bar"}'.
However, if I do not send any thing, then I do not get 400, i.e curl -X POST -H "Content-Type: application/json" /some/path does not result in 400 (and later results in 500 cause the object user is now null.
What am I doing wrong?
java jackson swagger
asked Jan 2 at 23:33
KoushaKousha
7,5131470159
add a comment |
I have the following:
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Path("/some/path")
void createSomething(@ApiParam(required = true) @Valid final User user);
And User is something like
class User {
@Valid
@NotNull
@NotBlank
final String name;
...
}
I do get back 400 if I do curl -X POST -H "Content-Type: application/json" /some/path -d '{"foo":"bar"}'.
However, if I do not send any thing, then I do not get 400, i.e curl -X POST -H "Content-Type: application/json" /some/path does not result in 400 (and later results in 500 cause the object user is now null.
What am I doing wrong?
java jackson swagger
asked Jan 2 at 23:33
KoushaKousha
7,5131470159
Your syntax looks OK, your test is valid ... and Swagger should certain support "required = true" for the @ApiParam annotation: docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/…. Q: What version of Swagger are you using? Also: Q: What kind of app are you running? A Java servlet? Spring Boot? "Something else"?
– paulsm4
Jan 2 at 23:39
@paulsm4 1.5.12. Also running a Dropwizard app
– Kousha
Jan 2 at 23:41
@paulsm4 if i add@NotNull(so have@ApiParam(required = true) @NotNull @Valid final User user) then it works. but that seems odd because as you saidrequiredon@ApiParamshould be doing that
– Kousha
Jan 2 at 23:44
I think Swagger is great. And if you happened to be using Spring Boot, I might even try to reproduce the problem myself. But it sounds like this might just be "one of those things" :( SUGGESTION: Check for "null" (and throw an exception) in your code. I'd recommend this regardless. It's not "redundant" - it's just a "smart thing to do:" ;) And of course, you can always ask about it here, too: swagger.io/community
– paulsm4
Jan 3 at 0:04
add a comment |
I have the following:
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Path("/some/path")
void createSomething(@ApiParam(required = true) @Valid final User user);
And User is something like
class User {
@Valid
@NotNull
@NotBlank
final String name;
...
}
I do get back 400 if I do curl -X POST -H "Content-Type: application/json" /some/path -d '{"foo":"bar"}'.
However, if I do not send any thing, then I do not get 400, i.e curl -X POST -H "Content-Type: application/json" /some/path does not result in 400 (and later results in 500 cause the object user is now null.
What am I doing wrong?
java jackson swagger
asked Jan 2 at 23:33
KoushaKousha
7,5131470159
I have the following:
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Path("/some/path")
void createSomething(@ApiParam(required = true) @Valid final User user);
And User is something like
class User {
@Valid
@NotNull
@NotBlank
final String name;
...
}
I do get back 400 if I do curl -X POST -H "Content-Type: application/json" /some/path -d '{"foo":"bar"}'.
However, if I do not send any thing, then I do not get 400, i.e curl -X POST -H "Content-Type: application/json" /some/path does not result in 400 (and later results in 500 cause the object user is now null.
What am I doing wrong?
java jackson swagger
java jackson swagger
asked Jan 2 at 23:33
KoushaKousha
7,5131470159
asked Jan 2 at 23:33
KoushaKousha
7,5131470159
asked Jan 2 at 23:33
KoushaKousha
7,5131470159
asked Jan 2 at 23:33
KoushaKousha
7,5131470159
asked Jan 2 at 23:33
KoushaKousha
7,5131470159
7,5131470159
Your syntax looks OK, your test is valid ... and Swagger should certain support "required = true" for the @ApiParam annotation: docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/…. Q: What version of Swagger are you using? Also: Q: What kind of app are you running? A Java servlet? Spring Boot? "Something else"?
– paulsm4
Jan 2 at 23:39
@paulsm4 1.5.12. Also running a Dropwizard app
– Kousha
Jan 2 at 23:41
@paulsm4 if i add@NotNull(so have@ApiParam(required = true) @NotNull @Valid final User user) then it works. but that seems odd because as you saidrequiredon@ApiParamshould be doing that
– Kousha
Jan 2 at 23:44
I think Swagger is great. And if you happened to be using Spring Boot, I might even try to reproduce the problem myself. But it sounds like this might just be "one of those things" :( SUGGESTION: Check for "null" (and throw an exception) in your code. I'd recommend this regardless. It's not "redundant" - it's just a "smart thing to do:" ;) And of course, you can always ask about it here, too: swagger.io/community
– paulsm4
Jan 3 at 0:04
add a comment |
Your syntax looks OK, your test is valid ... and Swagger should certain support "required = true" for the @ApiParam annotation: docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/…. Q: What version of Swagger are you using? Also: Q: What kind of app are you running? A Java servlet? Spring Boot? "Something else"?
– paulsm4
Jan 2 at 23:39
@paulsm4 1.5.12. Also running a Dropwizard app
– Kousha
Jan 2 at 23:41
@paulsm4 if i add@NotNull(so have@ApiParam(required = true) @NotNull @Valid final User user) then it works. but that seems odd because as you saidrequiredon@ApiParamshould be doing that
– Kousha
Jan 2 at 23:44
I think Swagger is great. And if you happened to be using Spring Boot, I might even try to reproduce the problem myself. But it sounds like this might just be "one of those things" :( SUGGESTION: Check for "null" (and throw an exception) in your code. I'd recommend this regardless. It's not "redundant" - it's just a "smart thing to do:" ;) And of course, you can always ask about it here, too: swagger.io/community
– paulsm4
Jan 3 at 0:04
Your syntax looks OK, your test is valid ... and Swagger should certain support "required = true" for the @ApiParam annotation: docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/…. Q: What version of Swagger are you using? Also: Q: What kind of app are you running? A Java servlet? Spring Boot? "Something else"?
– paulsm4
Jan 2 at 23:39
Your syntax looks OK, your test is valid ... and Swagger should certain support "required = true" for the @ApiParam annotation: docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/…. Q: What version of Swagger are you using? Also: Q: What kind of app are you running? A Java servlet? Spring Boot? "Something else"?
– paulsm4
Jan 2 at 23:39
@paulsm4 1.5.12. Also running a Dropwizard app
– Kousha
Jan 2 at 23:41
@paulsm4 1.5.12. Also running a Dropwizard app
– Kousha
Jan 2 at 23:41
@paulsm4 if i add
@NotNull (so have @ApiParam(required = true) @NotNull @Valid final User user) then it works. but that seems odd because as you said required on @ApiParam should be doing that– Kousha
Jan 2 at 23:44
@paulsm4 if i add
@NotNull (so have @ApiParam(required = true) @NotNull @Valid final User user) then it works. but that seems odd because as you said required on @ApiParam should be doing that– Kousha
Jan 2 at 23:44
I think Swagger is great. And if you happened to be using Spring Boot, I might even try to reproduce the problem myself. But it sounds like this might just be "one of those things" :( SUGGESTION: Check for "null" (and throw an exception) in your code. I'd recommend this regardless. It's not "redundant" - it's just a "smart thing to do:" ;) And of course, you can always ask about it here, too: swagger.io/community
– paulsm4
Jan 3 at 0:04
I think Swagger is great. And if you happened to be using Spring Boot, I might even try to reproduce the problem myself. But it sounds like this might just be "one of those things" :( SUGGESTION: Check for "null" (and throw an exception) in your code. I'd recommend this regardless. It's not "redundant" - it's just a "smart thing to do:" ;) And of course, you can always ask about it here, too: swagger.io/community
– paulsm4
Jan 3 at 0:04
add a comment |
1 Answer
1
active
oldest
votes
Swagger annotations do not perform any server-side validation of the input - they are only used to generate the swagger doc. Then you have to somehow create an user interface from the generated Swagger doc (for example by using Springfox swagger-ui if using Spring Boot https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui). And finally, if the UI is generated correctly, the UI would perform the validation.
Since in the examples you were sending the requests using Curl, the swagger annotations do nothing (because you aren't sending the requests through Swagger UI) and thus you can send null value. In order to perform server-side validation you have to use other annotations.
answered Jan 3 at 0:08
JanarJanar
1,7471120
The last time I used Swagger ("Swashbuckle", for .Net Core 2.x) the "generated Swagger doc" went hand-in-glove with the Swagger UI. It handled C# Annotations (er... C# "Attributes" ;)) just fine.
– paulsm4
Jan 3 at 0:21
yes it should, but it seems that the OP is not sending the requests through swagger UI and is using curl instead. Swagger annotations do not perform any server-side validation, they are only used for the generated swagger doc.
– Janar
Jan 3 at 0:22
Yup - you're right. I've only ever used EITHER curl OR Swagger (with Swagger UI), so I didn't realize that's what was happening. Thank you :) ALSO: I guess this a good example of why the OP should check for "user" in his code (and not rely exclusively on the annotation) ;)
– paulsm4
Jan 3 at 0:47
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54014562%2fswagger-apiparam-require-not-working-when-null-is-passed%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
Swagger annotations do not perform any server-side validation of the input - they are only used to generate the swagger doc. Then you have to somehow create an user interface from the generated Swagger doc (for example by using Springfox swagger-ui if using Spring Boot https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui). And finally, if the UI is generated correctly, the UI would perform the validation.
Since in the examples you were sending the requests using Curl, the swagger annotations do nothing (because you aren't sending the requests through Swagger UI) and thus you can send null value. In order to perform server-side validation you have to use other annotations.
answered Jan 3 at 0:08
JanarJanar
1,7471120
The last time I used Swagger ("Swashbuckle", for .Net Core 2.x) the "generated Swagger doc" went hand-in-glove with the Swagger UI. It handled C# Annotations (er... C# "Attributes" ;)) just fine.
– paulsm4
Jan 3 at 0:21
yes it should, but it seems that the OP is not sending the requests through swagger UI and is using curl instead. Swagger annotations do not perform any server-side validation, they are only used for the generated swagger doc.
– Janar
Jan 3 at 0:22
Yup - you're right. I've only ever used EITHER curl OR Swagger (with Swagger UI), so I didn't realize that's what was happening. Thank you :) ALSO: I guess this a good example of why the OP should check for "user" in his code (and not rely exclusively on the annotation) ;)
– paulsm4
Jan 3 at 0:47
add a comment |
Swagger annotations do not perform any server-side validation of the input - they are only used to generate the swagger doc. Then you have to somehow create an user interface from the generated Swagger doc (for example by using Springfox swagger-ui if using Spring Boot https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui). And finally, if the UI is generated correctly, the UI would perform the validation.
Since in the examples you were sending the requests using Curl, the swagger annotations do nothing (because you aren't sending the requests through Swagger UI) and thus you can send null value. In order to perform server-side validation you have to use other annotations.
answered Jan 3 at 0:08
JanarJanar
1,7471120
The last time I used Swagger ("Swashbuckle", for .Net Core 2.x) the "generated Swagger doc" went hand-in-glove with the Swagger UI. It handled C# Annotations (er... C# "Attributes" ;)) just fine.
– paulsm4
Jan 3 at 0:21
yes it should, but it seems that the OP is not sending the requests through swagger UI and is using curl instead. Swagger annotations do not perform any server-side validation, they are only used for the generated swagger doc.
– Janar
Jan 3 at 0:22
Yup - you're right. I've only ever used EITHER curl OR Swagger (with Swagger UI), so I didn't realize that's what was happening. Thank you :) ALSO: I guess this a good example of why the OP should check for "user" in his code (and not rely exclusively on the annotation) ;)
– paulsm4
Jan 3 at 0:47
add a comment |
Swagger annotations do not perform any server-side validation of the input - they are only used to generate the swagger doc. Then you have to somehow create an user interface from the generated Swagger doc (for example by using Springfox swagger-ui if using Spring Boot https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui). And finally, if the UI is generated correctly, the UI would perform the validation.
Since in the examples you were sending the requests using Curl, the swagger annotations do nothing (because you aren't sending the requests through Swagger UI) and thus you can send null value. In order to perform server-side validation you have to use other annotations.
answered Jan 3 at 0:08
JanarJanar
1,7471120
Swagger annotations do not perform any server-side validation of the input - they are only used to generate the swagger doc. Then you have to somehow create an user interface from the generated Swagger doc (for example by using Springfox swagger-ui if using Spring Boot https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui). And finally, if the UI is generated correctly, the UI would perform the validation.
Since in the examples you were sending the requests using Curl, the swagger annotations do nothing (because you aren't sending the requests through Swagger UI) and thus you can send null value. In order to perform server-side validation you have to use other annotations.
answered Jan 3 at 0:08
JanarJanar
1,7471120
answered Jan 3 at 0:08
JanarJanar
1,7471120
answered Jan 3 at 0:08
JanarJanar
1,7471120
answered Jan 3 at 0:08
JanarJanar
1,7471120
1,7471120
The last time I used Swagger ("Swashbuckle", for .Net Core 2.x) the "generated Swagger doc" went hand-in-glove with the Swagger UI. It handled C# Annotations (er... C# "Attributes" ;)) just fine.
– paulsm4
Jan 3 at 0:21
yes it should, but it seems that the OP is not sending the requests through swagger UI and is using curl instead. Swagger annotations do not perform any server-side validation, they are only used for the generated swagger doc.
– Janar
Jan 3 at 0:22
Yup - you're right. I've only ever used EITHER curl OR Swagger (with Swagger UI), so I didn't realize that's what was happening. Thank you :) ALSO: I guess this a good example of why the OP should check for "user" in his code (and not rely exclusively on the annotation) ;)
– paulsm4
Jan 3 at 0:47
add a comment |
The last time I used Swagger ("Swashbuckle", for .Net Core 2.x) the "generated Swagger doc" went hand-in-glove with the Swagger UI. It handled C# Annotations (er... C# "Attributes" ;)) just fine.
– paulsm4
Jan 3 at 0:21
yes it should, but it seems that the OP is not sending the requests through swagger UI and is using curl instead. Swagger annotations do not perform any server-side validation, they are only used for the generated swagger doc.
– Janar
Jan 3 at 0:22
Yup - you're right. I've only ever used EITHER curl OR Swagger (with Swagger UI), so I didn't realize that's what was happening. Thank you :) ALSO: I guess this a good example of why the OP should check for "user" in his code (and not rely exclusively on the annotation) ;)
– paulsm4
Jan 3 at 0:47
The last time I used Swagger ("Swashbuckle", for .Net Core 2.x) the "generated Swagger doc" went hand-in-glove with the Swagger UI. It handled C# Annotations (er... C# "Attributes" ;)) just fine.
– paulsm4
Jan 3 at 0:21
The last time I used Swagger ("Swashbuckle", for .Net Core 2.x) the "generated Swagger doc" went hand-in-glove with the Swagger UI. It handled C# Annotations (er... C# "Attributes" ;)) just fine.
– paulsm4
Jan 3 at 0:21
yes it should, but it seems that the OP is not sending the requests through swagger UI and is using curl instead. Swagger annotations do not perform any server-side validation, they are only used for the generated swagger doc.
– Janar
Jan 3 at 0:22
yes it should, but it seems that the OP is not sending the requests through swagger UI and is using curl instead. Swagger annotations do not perform any server-side validation, they are only used for the generated swagger doc.
– Janar
Jan 3 at 0:22
Yup - you're right. I've only ever used EITHER curl OR Swagger (with Swagger UI), so I didn't realize that's what was happening. Thank you :) ALSO: I guess this a good example of why the OP should check for "user" in his code (and not rely exclusively on the annotation) ;)
– paulsm4
Jan 3 at 0:47
Yup - you're right. I've only ever used EITHER curl OR Swagger (with Swagger UI), so I didn't realize that's what was happening. Thank you :) ALSO: I guess this a good example of why the OP should check for "user" in his code (and not rely exclusively on the annotation) ;)
– paulsm4
Jan 3 at 0:47
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54014562%2fswagger-apiparam-require-not-working-when-null-is-passed%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Your syntax looks OK, your test is valid ... and Swagger should certain support "required = true" for the @ApiParam annotation: docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/…. Q: What version of Swagger are you using? Also: Q: What kind of app are you running? A Java servlet? Spring Boot? "Something else"?
– paulsm4
Jan 2 at 23:39
@paulsm4 1.5.12. Also running a Dropwizard app
– Kousha
Jan 2 at 23:41
@paulsm4 if i add
@NotNull(so have@ApiParam(required = true) @NotNull @Valid final User user) then it works. but that seems odd because as you saidrequiredon@ApiParamshould be doing that– Kousha
Jan 2 at 23:44
I think Swagger is great. And if you happened to be using Spring Boot, I might even try to reproduce the problem myself. But it sounds like this might just be "one of those things" :( SUGGESTION: Check for "null" (and throw an exception) in your code. I'd recommend this regardless. It's not "redundant" - it's just a "smart thing to do:" ;) And of course, you can always ask about it here, too: swagger.io/community
– paulsm4
Jan 3 at 0:04