Ask a Question

ASPNet5 Code Generation: Separate resource files for API operation descriptions

ASPNet5 Code Generation: Separate resource files for API operation descriptions

The generation of c# puts descriptions in the <Remarks> tag for the operation on the controller.  This is ok but it tends to pollute the code and doesn't preserve the white space of the markdown.  We'd like to have swaggerhub generate resource files that we can link into our c# micro-service and use the swashbucke IDocumentFilter to read those files from code resources and provide them in swagger output.  This would also allow us to handle localization concerns in the future much more effectively.

 

Why: because once we generate the code, we push our micro-service through our continuous delivery process and only publish to our gateway from the micro-service host swagger.  So the format of those descriptions need to be maintained and presented by the code itself.

1 Comment
TanyaYatskovska
SmartBear Alumni (Retired)
Status changed to: New Idea
 
Announcements
Welcome to the SwaggerHub Feature Requests board!

Here you can review already submitted feature requests and vote up the ones you like! If you can't find the feature you want - go ahead and suggest your own idea. Ideas with the highest rating can be implemented in the product.

Check out the Create a Feature Request guide for more information.
New Here?
Welcome to the Community
Sign Up Here