ASP.NET Core - Swashbuckle not creating swagger.json file

Question

I am having trouble getting the Swashbuckle.AspNetCore (1.0.0) package to generate any output. I read the swagger.json file should be written to '~/swagger/docs/v1'. However, I am not getting any output.

I started with a brand new ASP.NET Core API project. I should mention this is ASP.NET Core 2. The API works, and I am able to retrieve values from the values controller just fine.

My startup class has the configuration exactly as described in this article (Swashbuckle.AspNetCore on GitHub).

public class Startup {     public Startup(IConfiguration configuration)     {         Configuration = configuration;     }      public IConfiguration Configuration { get; }      // This method gets called by the runtime. Use this method to add services to the container.     public void ConfigureServices(IServiceCollection services)     {         services.AddMvc();          services.AddSwaggerGen(c =>         {             c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });         });     }      // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.     public void Configure(IApplicationBuilder app, IHostingEnvironment env)     {         if (env.IsDevelopment())         {             app.UseDeveloperExceptionPage();              // Enable middleware to serve generated Swagger as a JSON endpoint.             app.UseSwagger();             app.UseSwaggerUI(c =>             {                 c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyAPI V1");             });         }         else         {             app.UseExceptionHandler();         }          app.UseStatusCodePages();         app.UseMvc();          //throw new Exception();     } } 

You can see the NuGet references...

Again, this is all the default template, but I include the ValuesController for reference...

[Route("api/[controller]")] public class ValuesController : Controller {     // GET api/values     [HttpGet]     public IEnumerable<string> Get()     {         return new string[] { "value1", "value2" };     }      // GET api/values/5     [HttpGet("{id}")]     public string Get(int id)     {         return "value";     }      // POST api/values     [HttpPost]     public void Post([FromBody]string value)     {     }      // PUT api/values/5     [HttpPut("{id}")]     public void Put(int id, [FromBody]string value)     {     }      // DELETE api/values/5     [HttpDelete("{id}")]     public void Delete(int id)     {     } } 

Answer 1

I had the same problem. Check http://localhost:XXXX/swagger/v1/swagger.json. If you get any a errors, fix them.

For example, I had an ambiguous route in a base controller class and I got the error: "Ambiguous HTTP method for action. Actions require an explicit HttpMethod binding for Swagger 2.0.". If you use base controllers make sure your public methods use the HttpGet/HttpPost/HttpPut/HttpDelete OR Route attributes to avoid ambiguous routes.

Then, also, I had defined both HttpGet("route") AND Route("route") attributes in the same method, which was the last issue for swagger.

Answer 2

I believe you missed these two lines on your Configure:

if (env.IsDevelopment()) {     app.UseDeveloperExceptionPage();      // Enable middleware to serve generated Swagger as a JSON endpoint.     app.UseSwagger();     app.UseSwaggerUI(c =>     {         c.SwaggerEndpoint("v1/swagger.json", "MyAPI V1");     }); } 

To access Swagger UI, the URL should be: http://localhost:XXXX/swagger/

The json can be found at the top of Swagger UI: