CODEWITHSUNDEEP
c#restasp.net-web-api2swagger-2.0swashbuckle
abraganza
abraganza

Reputation: 135

Is it possible to specify multiple assemblies for a Swashbuckle CustomAsset?

I am using Swashbuckle to embed Swagger documentation for our API into our .NET Web API 2.2 application (.NET 4.5). Up until now all the controllers have lived in the main Web API dll but as we start building out the API we are moving different version APIs to separate dlls.

When specifying a custom asset in Swashbuckle it is possible to specify 1 assembly for a resource path e.g. "v1" -> V1Assembly. However, I want to support the ability for the user to be able to view all API endpoints across all versions and assemblies. How do I make sure that this functionality is feasible with Swashbuckle? Essentially, I want a "all" or "index" endpoint on the help system to show all potential API Resources across all versioned assemblies.

My thought was a new feature that extends the SwaggerUiConfig to allow CustomAsset to accept an array of assemblies instead of just one so that we could interrogate multiple assemblies to generated the documentation instead of just the single one.

Any thoughts on how to accomplish this in the SwaggerConfig or otherwise?

Upvotes: 0

Views: 1109

Answers (1)

Helder Sepulveda
Helder Sepulveda

Reputation: 17594

If I understand correctly when you started versioning you ended up with multiple Web API.

You should consider refactoring your code using aspnet-api-versioning
All you will need to do in the controllers is identify them using something like:
[ApiVersion( "AreaOne" )]
https://github.com/Microsoft/aspnet-api-versioning/wiki/How-to-Version-Your-Service
For that Swashbuckle has full support.

Upvotes: 2

Related Questions