About the display of Swagger DTO Model parameters

Create 3 APIs as follows:

• MyEndpoint : Endpoint<MyRequest, MyResponse>，Get(“/my/query”);

The get request DTO model displays as expected on the swagger page.

• UserEndpoint : Endpoint<UserRequest<UserReqDto>, UserResponse<UserInfo>>，Get(“/user/query”);

The generic DTO model requested by get does not display as expected on the swagger page.

• YourEndpoint : Endpoint<YourRequest<YourReqDto>, YourResponse<YourInfo>>，Post(“/your/create”);

The general DTO model for POST requests is displayed as expected on the swagger page.

Strangely, none of the above DTO models display XML document annotation information. Is there any configuration error?

<PropertyGroup>
    <TargetFramework>net7.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

DTO model attributes all have XML document annotations. How to display them in the swagger?

For more information, please refer to demo: MyWebApp

Demo => Solution1.zip

ts!

[dj-nitehawk]

also it’s not recommended that you do GET requests with complex dto models. if the request data is complex, always put them in the body as json and make it a POST request, even if it’s a data retrieval operation. query params with complex objects is a bad practice imho. even though swagger/fetch client doesn’t support GET requests with a json body, the http spec doesn’t disallow it.

if you really must set examples/default values for complex/generic request dtos, you may be able to achieve that with a custom operation processor for nswag.

[zfchai]

Feedback has been provided, please check here：https://github.com/luoyunchong/IGeekFan.AspNetCore.Knife4jUI/issues/52