Get path of xml generated files in ASP.NET5 for using in Swashbuckle

Question

0.00/5 (No votes)

See more:

I want to generate the documentation of my webservice based on my code comments using swashbuckle. I followed the steps in

ASP.NET 5 MVC 6 API documentation using Swashbuckle Swagger - ASP.NET MVC tutorial for beginners[^]

So I have something like:

private string pathToDoc =
 "C:\\projectname\\artifacts\\bin\\projectname\\Debug\\dnx451\\projectname.xml";
public void ConfigureServices(IServiceCollection services)
{
 // Add framework services.
 services.AddMvc();

 services.AddSwaggerGen();

 services.ConfigureSwaggerDocument(options =>
 {
  options.SingleApiVersion(new Info
  {
   Version = "v1",
   Title = "Geo Search API",
   Description = "A simple api to search using geo location in Elasticsearch",
   TermsOfService = "None"
  });
  options.OperationFilter(new Swashbuckle.SwaggerGen.XmlComments.ApplyXmlActionComments(pathToDoc));
 });

 services.ConfigureSwaggerSchema(options =>
 {
  options.DescribeAllEnumsAsStrings = true;
  options.ModelFilter(new Swashbuckle.SwaggerGen.XmlComments.ApplyXmlTypeComments(pathToDoc));
 });

 services.AddScoped<ISearchProvider, SearchProvider>();

}

It is working ok, but I don't want to have hardcoded paths. I tried to calculate it using IHostingEnvironment.WebRootPath but it gets the path to a different folder tree.

Is there a way to get this path?

Posted 14-Jan-16 23:34pm

Kilian Chouza

Updated 14-Jan-16 23:42pm

v2

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

AndyEdmonds · Accepted Answer · 2016-02-14T06:12:00

The bigger problem is that this approach will not work at all in Azure, since you won't know the file path in advance.
The solution seems to be to move the XML file to the wwwroot and define the pathToDoc in Startup.cs in the constructor:

C#

public class Startup
    {
        private string pathToDoc;
        public Startup(IHostingEnvironment env)
        {
            // Set up configuration sources.
            var builder = new ConfigurationBuilder()
                .AddJsonFile("appsettings.json")
                .AddEnvironmentVariables();
            Configuration = builder.Build();
            pathToDoc = env.WebRootPath + @"\docweb1.xml";
        }

This is working for me on Azure.