Swagger(ASP.NET Core)

Swaggerを入れて、動作確認をしやすくする。
下記を参考に Swashbuckle をインストールする
(参考)Swagger/OpenAPI を使用する ASP.NET Core Web API のドキュメント

スポンサーリンク

前提環境

Visual Studio2019
Windows10
Web API プロジェクト

開発

Swagger(Swashbuckle)インストール

NuGetで「Swashbuckle.AspNetCore」をインストール。

Swaggerの設定。

 ・・・
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddRazorPages();
            services.AddControllers(); // 追加
            services.AddSwaggerGen(); // 追加
 ・・・
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
                app.UseSwagger(); // 追加
                app.UseSwaggerUI(); // 追加

実行時にSwaggerを表示する。

    "WebApplication2": {
      "commandName": "Project",
      "dotnetRunMessages": "true",
      "launchBrowser": true,
      "launchUrl": "swagger", // 追加
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }

実行

デバッグ実行し、「https://localhost:5001/swagger/index.html」にアクセスする。

コメント

タイトルとURLをコピーしました