-
Notifications
You must be signed in to change notification settings - Fork 4.6k
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
[Improvement][swagger] Now the interface document returns only the generic template #11208
Comments
Search before asking
DescriptionIf the developer is a front end, he wants to see the data structure in 'data'If the response attribute of the annotation @ApiOperation is used, the interface document can see the data structure of data, but cannot see the general return template. Can you give some advice? Need a discussion tag? Are you willing to submit a PR?
Code of Conduct
|
Thank you for your feedback, we have received your issue, Please wait patiently for a reply.
|
This is one of the reasons why we refactor the API in #10257. Currently, you can debug by opening F12 in the page to view the format of specific parameters. |
@SbloodyS Although after your modification, I can only see the unified return structure。 {
"code": 0,
"data": {},
"failed": true,
"msg": "",
"success": true
} i mean as a ui,even if some default values of f12 are null, the front end cannot judge the type of the parameter, nor does it know the meaning of each attribute of the object in 'data'.so why i open this issue |
You can find the data structure through swagger ui after refactor to v2 api. For more detail you can take a look at #10301. |
@SbloodyS you are so smart,thx |
Search before asking
Description
If the developer is a front end, he wants to see the data structure in 'data'
If the response attribute of the annotation @ApiOperation is used, the interface document can see the data structure of data, but cannot see the general return template. Can you give some advice? Need a discussion tag?
@SbloodyS @EricGao888
Are you willing to submit a PR?
Code of Conduct
The text was updated successfully, but these errors were encountered: