ASP.NET Core로 C# 웹 애플리케이션 만들기

기본 애플리케이션 실행

팀은 개발자들이 기본적으로 제공받는 기능을 설명하기 위해 기본 애플리케이션을 실행하는 것으로 시작합니다. 프로젝트가 실행되면 API를 빌드하고 필요한 NuGet 패키지를 다운로드한 후 웹 페이지를 실행합니다. 이 초기 설정은 어떠한 수정도 없이 API의 기본 구조와 기능을 보여줍니다.

API와의 상호작용

실행되는 웹 페이지는 현재 OpenAPI로 알려진 Swagger를 기반으로 합니다. Swagger는 API와 상호 작용하기 위한 사용자 친화적인 인터페이스를 제공합니다. 이를 통해 개발자와 비개발자 모두 API 엔드포인트를 쉽게 이해하고 테스트할 수 있습니다. 이 인터페이스는 API 작동 방식을 시각화하고 문서화하는 데 특히 유용합니다.

스웨거 탐구하기

Swagger는 API에서 사용 가능한 엔드포인트를 보여줍니다. 기본 설정에서 미리 구성된 엔드포인트 중 하나는 "날씨 예보" 엔드포인트입니다. 이 엔드포인트를 클릭하고 "직접 사용해 보기" 기능을 사용하면 사용자는 API 호출을 실행하고 응답을 확인할 수 있습니다. 이 응답에는 JSON 형식의 날씨 예보가 포함되어 있으며, API에서 데이터가 반환되는 방식을 보여줍니다.

Tim은 8분 32초에 원시 JSON 데이터를 브라우저에서 직접 읽는 것은 어려울 수 있지만, Swagger의 문서 오버레이 덕분에 훨씬 더 이해하기 쉬워진다고 강조합니다. 문서에는 요청 메서드(GET, POST 등), 반환되는 데이터의 구조 및 필수 매개변수를 포함하여 엔드포인트에 대한 자세한 정보가 제공됩니다.

JSON 문서화 및 API 버전 관리

Swagger는 Tim이 9분 10초에 언급한 것처럼 API를 기계가 읽을 수 있는 형식으로 문서화하는 JSON 파일도 생성합니다. 이 문서는 사용 가능한 엔드포인트, 데이터 스키마 및 예상 응답을 설명하므로 API와 상호 작용해야 하는 다른 애플리케이션에 매우 중요합니다.

Tim은 9시 29분에 API 버전 관리의 중요성을 지적합니다. 기본 설정에는 버전 표시기가 포함되어 있어 여러 API 버전이 존재할 가능성을 암시합니다. 버전 관리는 하위 호환성을 유지하는 데 필수적입니다. API 변경으로 기존 클라이언트가 제대로 작동하지 않을 수 있는 경우, 여러 버전을 보유하면 개발자는 현재 사용자를 방해하지 않고 새로운 기능이나 변경 사항을 도입할 수 있습니다.

API의 목적

팀은 대부분의 애플리케이션이 데이터, 즉 데이터 검색, 조작 및 표시를 중심으로 이루어진다고 강조합니다. API는 사용자 인터페이스와 기본 데이터 사이의 중개자 역할을 하며, 안전하고 효율적인 데이터 접근 수단을 제공합니다. 이러한 중앙집중화는 여러 가지 이유로 매우 중요합니다.

1. 보안 : API는 데이터 접근을 관리하는 안전한 방법을 제공합니다. 모바일 및 클라이언트 측 애플리케이션은 데이터베이스에 직접 연결해서는 안 됩니다. 클라이언트 코드에 데이터베이스 자격 증명을 포함시키면 심각한 보안 위험이 발생하기 때문입니다.

2. 추상화 : API는 데이터 계층을 사용자 인터페이스에서 추상화하여 다양한 클라이언트 애플리케이션(모바일 앱, 웹 앱, 데스크톱 앱)이 데이터베이스나 자격 증명을 노출하지 않고도 동일한 데이터 소스와 상호 작용할 수 있도록 합니다.

다양한 프레임워크에서의 활용성

팀은 API가 특정 프레임워크나 언어에 국한되지 않는다고 지적합니다. 예를 들어, C# API는 Angular, React 또는 Vue와 같은 JavaScript 프레임워크에서 접근할 수 있으며, 이는 API의 크로스 플랫폼 기능을 보여줍니다.

1. Program.cs 개요

Tim은 Program.cs 파일을 검토하면서 이 파일이 웹 애플리케이션을 빌드하고 컨트롤러의 종속성 주입 및 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에서 환경 설정이 구성되는 방법을 설명합니다. 기본 환경은 로컬 테스트를 위한 "개발"로 설정되어 있으며, 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 리디렉션 및 컨트롤러

팀은 HTTPS 리디렉션과 컨트롤러 매핑에 대해 지적합니다. 이 설정을 통해 API 경로가 올바르게 구성됩니다. 그는 HTTP 요청 및 응답 경로의 명확성을 위해 "api" 접두사를 사용하는 것을 선호하며, 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 동사 및 라우팅

팀은 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는 모든 사용자를 검색하며, /users/5는 ID가 5인 특정 사용자를 검색합니다.

3. REST 규정 준수 : 팀은 REST가 원래 이론적인 모델이었기 때문에 완전한 REST 규정 준수를 달성하는 것이 어려울 수 있다고 지적합니다. 하지만 REST 원칙을 준수하면 더욱 직관적이고 일관성 있는 API를 만들 수 있습니다.

팀은 REST API 규정 준수를 목표로 하되, 사용성과 기능성을 보장하기 위해 실질적인 고려 사항을 바탕으로 API를 설계해야 한다고 강조합니다.

최소 API 애플리케이션

코리는 ASP.NET Core 에서 API 개발을 위한 간소화된 접근 방식인 '미니멀 API'를 소개합니다.

1. 최소 API 설정 : Tim은 프로젝트 설정 시 "컨트롤러 사용" 옵션을 선택 해제하여 최소 API 프로젝트를 만드는 방법을 보여줍니다.

2. 간소화된 코드: 최소화된 API는 컨트롤러와 라우팅 속성의 필요성을 제거하여 개발자가 Program.cs에서 app.MapGet(), app.MapPost() 등의 메소드를 사용하여 직접 엔드포인트를 정의할 수 있게 합니다.

3. 코드 예시 : Tim은 단 한 줄의 코드로 엔드포인트를 정의하는 코드 예시를 제공합니다. 그는 최소한의 설정으로 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는 특히 소규모 애플리케이션이나 마이크로서비스의 개발을 단순화하도록 설계되었습니다.