1. ホーム
  2. c#

[解決済み] ASP.NET Core - Swashbuckle が swagger.json ファイルを作成しない。

2023-01-23 04:41:01

質問

Swashbuckle.AspNetCore (1.0.0) パッケージが出力を生成するのに苦労しています。 私はswagger.jsonファイルが'~/swagger/docs/v1'に書き込まれるべきであると読みました。 しかし、私は何の出力も得ていません。

私は真新しい ASP.NET Core API プロジェクトで開始しました。これは、ASP.NET Core 2 であることを言及しなければなりません。API は動作し、values コントローラーからうまく値を取得することができます。

私のスタートアップクラスは、この記事で説明されているとおりの構成になっています ( 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();
    }
}

NuGetのリファレンスを見ることができます...

これも全てデフォルトのテンプレートですが、参考までにValuesControllerを載せておきます...。

[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)
    {
    }
}

どのように解決するのですか?

設定にこの2行が抜けているのではないでしょうか。

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");
    });
}

Swagger UIにアクセスするために、URLは以下のようにします。 http://localhost:XXXX/swagger/

jsonはSwagger UIの上部にあります。