ASP.NET Core Web API 시작하기 - 설치부터 예제까지
1. ASP.NET Core Web API란?
ASP.NET Core Web API는 마이크로소프트가 제공하는 오픈소스 기반의 백엔드 프레임워크로, RESTful API를 쉽게 개발할 수 있도록 지원합니다. 웹, 모바일, 데스크톱, IoT 등 다양한 클라이언트에서 활용할 수 있는 서버 애플리케이션을 제작할 수 있으며, Cross-platform을 지원하여 Windows뿐만 아니라 Linux, macOS 환경에서도 실행이 가능합니다.
2. 개발 환경 준비하기
ASP.NET Core Web API를 시작하기 위해서는 다음과 같은 환경 구성이 필요합니다.
- .NET SDK (최신 LTS 버전 권장)
- Visual Studio 2022 또는 Visual Studio Code
- Postman 또는 Swagger UI (API 테스트용)
.NET SDK는 공식 다운로드 페이지에서 설치할 수 있으며, 설치 후 터미널에서 dotnet --version 명령어를 입력해 정상적으로 설치되었는지 확인할 수 있습니다.
3. 새로운 Web API 프로젝트 생성
개발 환경이 준비되었다면, 이제 새로운 Web API 프로젝트를 만들어보겠습니다.
dotnet new webapi -o MyFirstApi
cd MyFirstApi
dotnet run위 명령어를 실행하면 MyFirstApi라는 이름의 Web API 프로젝트가 생성됩니다. 기본 템플릿에는 WeatherForecast 컨트롤러가 포함되어 있어, 브라우저 또는 Swagger UI에서 기본 API 동작을 확인할 수 있습니다.
4. Web API 프로젝트 구조 이해하기
ASP.NET Core Web API 프로젝트의 기본 구조는 다음과 같습니다.
- Program.cs : 애플리케이션 진입점, 서비스와 미들웨어 구성
- Controllers : API 엔드포인트를 정의하는 컨트롤러 모음
- appsettings.json : 환경 설정 파일 (DB 연결, 로깅, 설정 값 저장)
- Properties/launchSettings.json : 로컬 실행 시 설정
이 구조를 이해하면, 프로젝트가 어떻게 실행되고 API 요청이 어떻게 처리되는지 명확하게 알 수 있습니다.
5. 첫 번째 API 컨트롤러 만들기
이제 새로운 API 엔드포인트를 추가해보겠습니다. Controllers 폴더 안에 HelloController.cs 파일을 만듭니다.
using Microsoft.AspNetCore.Mvc;
namespace MyFirstApi.Controllers
{
[ApiController]
[Route("api/[controller]")]
public class HelloController : ControllerBase
{
[HttpGet]
public string Get()
{
return "Hello, ASP.NET Core Web API!";
}
}
}위 코드를 실행한 후 브라우저에서 https://localhost:5001/api/hello로 접속하면 "Hello, ASP.NET Core Web API!"라는 문자열이 출력됩니다.
6. Swagger로 API 테스트하기
ASP.NET Core Web API 템플릿에는 Swagger가 기본적으로 포함되어 있어, API를 시각적으로 확인하고 테스트할 수 있습니다. 실행 후 브라우저에서 /swagger 경로로 접속하면 자동으로 API 문서가 생성됩니다.
7. 앞으로 나아가기
이번 글에서는 ASP.NET Core Web API의 기본 개념과 설치 방법, 프로젝트 생성과 간단한 예제를 살펴보았습니다. 다음 단계에서는 Entity Framework Core를 활용한 데이터베이스 연동, JWT 인증 기반의 보안 적용, 미들웨어를 활용한 로깅과 예외 처리 등을 학습할 수 있습니다.
꾸준히 학습하면 C#과 ASP.NET Core를 활용한 Full-Stack Web Development의 기초를 다질 수 있을 것입니다.