Nested object is not shown in Swagger documentation
I'm working with swagger-springfox on version 2.9.2, I encountered a problem with incomplete display of multiple nested objects.
I have a class named AddEntityCaseReq and the structure below. When I visited the swagger-ui.html, there is nothing in the Properties.
I have marked @ApiModel and @ApiModelProperties on each class. Is there anything missing?
This is the class structure
AddEntityCaseReq
├── id
└── List<UploadDocuments> uploadDocuments;
└── Properties
├── id
└── name
This is the controller code
@ResponseBody
@RequestMapping(value = "/addEntityCase", method = RequestMethod.POST)
@ApiOperation(value = "add entity case", notes = "add entity case")
@ApiImplicitParam(name = "addEntityCaseReq", value = "reuqest",
required = true, dataType = "AddEntityCaseReq")
public CommonResp<Boolean> addEntityCase(@RequestBody AddEntityCaseReq addEntityCaseReq)
return addEntityCase.execute(addEntityCaseReq);
swagger model details here
java spring-boot swagger springfox
edited Nov 15 '18 at 8:44
jps
3,84372037
asked Nov 15 '18 at 2:02
AezioAezio
3810
add a comment |
I'm working with swagger-springfox on version 2.9.2, I encountered a problem with incomplete display of multiple nested objects.
I have a class named AddEntityCaseReq and the structure below. When I visited the swagger-ui.html, there is nothing in the Properties.
I have marked @ApiModel and @ApiModelProperties on each class. Is there anything missing?
This is the class structure
AddEntityCaseReq
├── id
└── List<UploadDocuments> uploadDocuments;
└── Properties
├── id
└── name
This is the controller code
@ResponseBody
@RequestMapping(value = "/addEntityCase", method = RequestMethod.POST)
@ApiOperation(value = "add entity case", notes = "add entity case")
@ApiImplicitParam(name = "addEntityCaseReq", value = "reuqest",
required = true, dataType = "AddEntityCaseReq")
public CommonResp<Boolean> addEntityCase(@RequestBody AddEntityCaseReq addEntityCaseReq)
return addEntityCase.execute(addEntityCaseReq);
swagger model details here
java spring-boot swagger springfox
edited Nov 15 '18 at 8:44
jps
3,84372037
asked Nov 15 '18 at 2:02
AezioAezio
3810
add a comment |
I'm working with swagger-springfox on version 2.9.2, I encountered a problem with incomplete display of multiple nested objects.
I have a class named AddEntityCaseReq and the structure below. When I visited the swagger-ui.html, there is nothing in the Properties.
I have marked @ApiModel and @ApiModelProperties on each class. Is there anything missing?
This is the class structure
AddEntityCaseReq
├── id
└── List<UploadDocuments> uploadDocuments;
└── Properties
├── id
└── name
This is the controller code
@ResponseBody
@RequestMapping(value = "/addEntityCase", method = RequestMethod.POST)
@ApiOperation(value = "add entity case", notes = "add entity case")
@ApiImplicitParam(name = "addEntityCaseReq", value = "reuqest",
required = true, dataType = "AddEntityCaseReq")
public CommonResp<Boolean> addEntityCase(@RequestBody AddEntityCaseReq addEntityCaseReq)
return addEntityCase.execute(addEntityCaseReq);
swagger model details here
java spring-boot swagger springfox
edited Nov 15 '18 at 8:44
jps
3,84372037
asked Nov 15 '18 at 2:02
AezioAezio
3810
I'm working with swagger-springfox on version 2.9.2, I encountered a problem with incomplete display of multiple nested objects.
I have a class named AddEntityCaseReq and the structure below. When I visited the swagger-ui.html, there is nothing in the Properties.
I have marked @ApiModel and @ApiModelProperties on each class. Is there anything missing?
This is the class structure
AddEntityCaseReq
├── id
└── List<UploadDocuments> uploadDocuments;
└── Properties
├── id
└── name
This is the controller code
@ResponseBody
@RequestMapping(value = "/addEntityCase", method = RequestMethod.POST)
@ApiOperation(value = "add entity case", notes = "add entity case")
@ApiImplicitParam(name = "addEntityCaseReq", value = "reuqest",
required = true, dataType = "AddEntityCaseReq")
public CommonResp<Boolean> addEntityCase(@RequestBody AddEntityCaseReq addEntityCaseReq)
return addEntityCase.execute(addEntityCaseReq);
swagger model details here
java spring-boot swagger springfox
java spring-boot swagger springfox
edited Nov 15 '18 at 8:44
jps
3,84372037
asked Nov 15 '18 at 2:02
AezioAezio
3810
edited Nov 15 '18 at 8:44
jps
3,84372037
asked Nov 15 '18 at 2:02
AezioAezio
3810
edited Nov 15 '18 at 8:44
jps
3,84372037
edited Nov 15 '18 at 8:44
jps
3,84372037
edited Nov 15 '18 at 8:44
jps
3,84372037
3,84372037
asked Nov 15 '18 at 2:02
AezioAezio
3810
asked Nov 15 '18 at 2:02
AezioAezio
3810
asked Nov 15 '18 at 2:02
AezioAezio
3810
3810
add a comment |
add a comment |
0
active
oldest
votes
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%2f53311385%2fnested-object-is-not-shown-in-swagger-documentation%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
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%2f53311385%2fnested-object-is-not-shown-in-swagger-documentation%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
