swagger

ASP.NET Core - 9. 고급 Web Service 기능

이번 Posting에서는 RESTful web service를 생성할 때 사용할 수 있는 고급 기능들에 대해서 알아보고자 합니다. 대략적으로 Entity Framework Core사용 시 관련 Data를 다루는 방법과 HTTP PATCH method 지원을 추가하는 방법, web service의 명세를 서술하기 위한 OpenAPI사용법 등에 관한 내용을 알아볼 것입니다. 1. 준비사항 해당 글의 예제는 이전글에서 사용하던 Project를 그대로 이어서 사용할 것입니다. 다만 추가적으로 Controllers folder에 SuppliersController.cs라는 file을 아래 내용으로 추가해 줍니다. using Microsoft.AspNetCore.Mvc; using MyWebApp.Models; n..

[ASP.NET Core Web API] Swagger와 API 명세

백엔드에서 API를 만들고 나면 프런트엔드에서 이를 활용하기 위해 어떤 방법으로 필요한 데이터를 전송하고 받을지에 대한 설명서가 필요합니다. 이를 API명세라고도 하며 Swagger를 사용하면 API명세가 담긴 UI를 손쉽게 생성할 수 있고 테스트도 가능합니다. Swagger를 사용하기 위해서는 우선 NuGet Package에서 'Swashbuckle.AspNetCore'를 검색해 해당 Package를 설치해 줍니다. 그리고 startup.cs에서 ConfigureServices() 메서드에서 다음과 같이 API 문서의 제목과 버전 정보 등을 등록합니다. services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "myapi", ..