search

rbeauchamp / Swashbuckle.OData

Extends Swashbuckle with OData v4 support!
Other
129 stars 96 forks source link

IncludeXmlComments and AddCustomSwaggerRoute #148

Closed jmsvl closed 4 years ago

jmsvl commented 7 years ago

Hi,

Is Swashbuckle.OData going to support Xml Comments external files?

And I also cannot get any documentation on CustomSwaggerRoutes to show.

Thanks,

Jorge

cibergarri commented 7 years ago

Hi Jorge, actually Swashbuckle.OData support Xml Comment external files since some months ago. You can see an example of this working in the sample project: https://github.com/rbeauchamp/Swashbuckle.OData/blob/9d5fa0a74c0dea49a20c643aab428be21aa3363e/Swashbuckle.OData.Sample/App_Start/SwaggerConfig.cs Regarding the CustomSwaggerRoutes, you have some information in the readme: https://github.com/rbeauchamp/Swashbuckle.OData#custom-swagger-routes

Regards. Javier.

jmsvl commented 7 years ago

I have tried the sample and, indeed, it works as intended. But we're using MultipleApiVersions instead of single as in the sample.

Could this be causing the problem with our xml external file?

jmsvl commented 7 years ago

I think I've found the problem and opened an Issue on Swashbuckle describing it:

https://github.com/domaindrivendev/Swashbuckle/issues/1102

jmsvl commented 7 years ago

Can anyone help me with the issue?

You can see the print screens below running the Sample that Customers OData controller cannot get xml comments when using config.EnableSystemDiagnosticsTracing(); (NuGet Microsoft.AspNet.WebApi.Tracing v5.2.3) on Register method of WebApiConfig.cs

image