ASP.NET CoreでC#ウェブアプリケーションを作成する

デフォルト アプリケーションの実行

Timはまず、デフォルトのアプリケーションを実行し、開発者が箱から出してすぐに使えるものを説明します。 プロジェクトが実行されると、APIがビルドされ、必要なNuGetパッケージがダウンロードされ、Webページが起動します。 この初期セットアップでは、APIの基本的な構造と機能性をそのまま示します。

APIとの相互作用

起動するウェブページは、現在OpenAPIとして知られているSwaggerで動いています。 Swaggerは、APIと対話するためのユーザーフレンドリーなインターフェイスを提供します。 これにより、開発者と非開発者の両方がAPIエンドポイントを簡単に理解し、テストできるようになります。 このインターフェイスは、APIがどのように動作するかを視覚化し、ドキュメンテーションの目的で特に有益です。

Swaggerについて

Swaggerは、APIで利用可能なエンドポイントを紹介します。 デフォルトのセットアップでは、設定済みのエンドポイントの1つは "天気予報 "エンドポイントです。 このエンドポイントをクリックし、"Try it out "機能を使用することで、ユーザーはAPIコールを実行し、レスポンスを確認することができます。 このレスポンスにはJSON形式の天気予報が含まれており、APIからどのようにデータが返されるかを示しています。

8:32のTimは、生のJSONデータはブラウザから直接読むのは難しいかもしれないが、Swaggerのドキュメンテーションオーバーレイを使えばはるかに消化しやすくなることを強調している。 ドキュメントでは、リクエストメソッド（GET、POSTなど）、返されるデータの構造、必要なパラメータなど、エンドポイントに関する詳細な情報を提供します。

JSONドキュメンテーションとAPIバージョン管理

Swaggerは、9:10でTimが指摘するように、APIを機械可読形式で文書化したJSONファイルも生成します。 このドキュメントは、利用可能なエンドポイント、データスキーマ、および期待される応答について説明するため、APIと相互作用する必要がある他のアプリケーションにとって非常に重要です。

9:29のTimは、APIにおけるバージョン管理の重要性を指摘している。デフォルトのセットアップにはバージョンインジケーターが含まれており、複数のAPIバージョンの可能性を示唆している。 バージョン管理は、後方互換性を維持するために不可欠です。 APIへの変更が既存のクライアントを壊す可能性がある場合、複数のバージョンを持つことで、開発者は現在のユーザーを混乱させることなく新機能や変更を導入することができます。

APIの目的

ティムは、ほとんどのアプリケーションはデータ検索、操作、表示を中心に展開されると強調する。 APIは、ユーザーインターフェースと基礎となるデータとの仲介役として機能し、安全で効率的なデータアクセス手段を提供します。 この一元化は、いくつかの理由から非常に重要です：

1.セキュリティ：APIはデータアクセスを管理する安全な方法を提供します。 モバイルおよびクライアントサイドのアプリケーションは、重大なセキュリティリスクをもたらすデータベース認証情報をクライアントコード内に埋め込むことを避けるため、データベースに直接接続すべきではありません。

2.抽象化：APIはユーザーインターフェイスからデータレイヤーを抽象化し、異なるクライアントアプリケーション（モバイルアプリ、ウェブアプリ、デスクトップアプリ）がデータベースやその認証情報を公開することなく、同じデータソースとやりとりできるようにします。

さまざまなフレームワークでの多用途性

ティムは、APIは特定のフレームワークや言語に限定されるものではないことを指摘しています。 例えば、C# APIは、Angular、React、Vueなど for JavaScriptフレームワークからアクセスでき、APIのクロスプラットフォーム機能を紹介します。

1.Program.csの概要1.

TimはProgram.csをレビューし、Webアプリケーションを構築し、コントローラやSwagger (OpenAPI)の依存性注入のようなサービスを設定することを指摘します。 コードは、アプリケーションをビルドして実行する前に、必要不可欠なサービスを設定します。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

2.環境設定

TimはlaunchSettings.jsonで環境設定がどのように構成されているかを説明します。 デフォルト環境はローカルテスト用に "Development "に設定され、Swaggerが有効になります。 本番環境では、セキュリティのためSwaggerは通常無効になっていますが、開発チェックを外すことで有効にすることができます。

{
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "WebApplication": {
      "commandName": "Project",
      "launchBrowser": true,
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

3.HTTPSリダイレクトとコントローラ

Timは、HTTPSリダイレクトとコントローラのマッピングについて指摘しています。 このセットアップでは、APIルートが適切に設定されていることを確認します。 彼は、HTTPリクエストとレスポンスのルートを明確にするために、"api "という接頭辞を使用することを好みます。

4.天気予報コントローラー

TimはWeatherForecastController.csに深く入り込み、ルート設定を強調します。 デフォルトのルートは/weatherforecastであり、"api"プレフィックスを含めるように変更できます。 コントローラは、データを取得するためにHTTP GETを使用し、指定されたルート経由でアクセスできます。

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    private readonly ILogger<WeatherForecastController> _logger;

    public WeatherForecastController(ILogger<WeatherForecastController> logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public IEnumerable<WeatherForecast> Get()
    {
        return Enumerable.Range(1, 5).Select(index => new WeatherForecast
        {
            Date = DateTime.Now.AddDays(index),
            TemperatureC = Random.Shared.Next(-20, 55),
            Summary = Summaries[Random.Shared.Next(Summaries.Length)]
        })
        .ToArray();
    }
}

public class WeatherForecast
{
    public DateTime Date { get; set; }

    public int TemperatureC { get; set; }

    public string? Summary { get; set; }
}

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    private readonly ILogger<WeatherForecastController> _logger;

    public WeatherForecastController(ILogger<WeatherForecastController> logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public IEnumerable<WeatherForecast> Get()
    {
        return Enumerable.Range(1, 5).Select(index => new WeatherForecast
        {
            Date = DateTime.Now.AddDays(index),
            TemperatureC = Random.Shared.Next(-20, 55),
            Summary = Summaries[Random.Shared.Next(Summaries.Length)]
        })
        .ToArray();
    }
}

public class WeatherForecast
{
    public DateTime Date { get; set; }

    public int TemperatureC { get; set; }

    public string? Summary { get; set; }
}

5.HTTP動詞とルーティング

Timは、HTTP動詞（GET、POST、PUT、DELETE）がどのようにAPIエンドポイントを定義するかを説明します。 GETリクエストでは、ブラウザはコントローラ内の指定されたメソッドを呼び出します。 その他の動詞には、テスト用のPostmanのようなツールが必要です。

REST API

ティム・コリーは、REST（Representational State Transfer）とその原理を紹介しています：

1.RESTとは：RESTは、ネットワークアプリケーションを設計するためのアーキテクチャスタイルです。 ステートレス通信に依存し、標準的なHTTPメソッド（GET、POST、PUT、DELETE）を使用して操作を実行します。

2.RESTfulの原則：RESTful APIは、リソースを表すためにURLパターンを使用します。 例えば、/users/5はID 5の特定のユーザーを取得します。

3.RESTコンプライアンス: Timは、RESTはもともと理論的なモデルであったため、RESTの完全なコンプライアンスを達成するのは難しいことだと述べています。 しかし、RESTの原則に従うことで、より直感的で一貫性のあるAPIを実現することができます。

ティム氏は、RESTへの準拠を目指す一方で、使いやすさと機能性を確保するために、実用的な考慮事項をAPI設計の指針にする必要があることを強調しています。

最小限の API アプリケーション

Coreyは、ASP.NET CoreにおけるAPI開発の合理化アプローチであるMinimal APIを紹介します：

1.Setting Up Minimal APIs: Timは、プロジェクトのセットアップ時に"Use Controllers"オプションのチェックを外して、Minimal APIプロジェクトを作成する方法を示します。

2. 簡素化されたコード: ミニマムAPIはコントローラやルーティング属性の必要性を排除し、開発者がapp.MapPost()のようなメソッドを使って直接エンドポイントを定義できるようにします。

3.コード例: Timは、1行のコードがエンドポイントを定義するコード例を提供します。 最小限の構成で、GETリクエストをエンドポイントにマッピングする方法を示します。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.MapGet("/", () => "Hello World!");

app.Run();

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.MapGet("/", () => "Hello World!");

app.Run();

最小限のAPIは、特に小規模なアプリケーションやマイクロサービスの開発を簡素化するように設計されています。