C# ASP.NET WebAPI 테스트 방법 – Swagger와 Postman 활용 가이드

WebAPI 테스트는 요청(Request)을 전송하고 그에 대한 응답(Response)을 수신하는 과정으로 이루어집니다. WebAPI를 테스트하는 방법은 여러 가지가 있지만, 이 글에서는 가장 널리 사용되는 Swagger와 Postman 두 가지 도구를 활용한 테스트 방법을 소개합니다.

먼저 아래와 같이 StudentController를 생성해 보겠습니다.

Student 모델

namespace DemoWebApplication Models{
    public class Student{
        public int Id { get; set; }
        public string Name { get; set; }
    }
}

Student 컨트롤러

예제 코드

using DemoWebApplication.Models;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;
namespace DemoWebApplication.Controllers{
    public class StudentController : ApiController{
        List<Student> students = new List<Student>{
            new Student{
                Id = 1,
                Name = "Mark"
            },
            new Student{
                Id = 2,
                Name = "John"
            }
        };
        public IEnumerable<Student> Get(){
            return students;
        }
        public Student Get(int id){
            var studentForId = students.FirstOrDefault(x => x.Id == id);
            return studentForId;
        }
    }
}

위 컨트롤러는 두 개의 GET 액션 메서드를 제공합니다. 하나는 전체 학생 목록을 반환하고, 다른 하나는 특정 ID에 해당하는 학생 정보를 반환합니다.

Swagger를 사용한 테스트

Swagger는 REST API를 문서화하기 위한 표준 사양(Specification)입니다. URL, HTTP 메서드, 표현 방식 등의 형식을 정의하여 REST 웹 서비스를 체계적으로 기술할 수 있습니다. 메서드, 매개변수, 모델에 대한 설명이 서버 코드와 긴밀하게 통합되어 있기 때문에 API와 문서 간의 동기화가 항상 유지된다는 것이 큰 장점입니다.

프로젝트에서 Swagger를 사용하려면 NuGet 패키지 관리(Manage NuGet Packages)를 통해 Swashbuckle 패키지를 설치하면 됩니다.