asp.net swagger api에서 c#코드 주석이 swagger주석으로 나오도록 하기

asp.net으로 rest api개발할 때 Swashbuckle.AspNetCore 패키지를 많이 사용할 것입니다.

그런데 기본 설정으로는 소스코드의 주석이 swagger주석으로 출력되지 않기 때문에 다음 설정을 해줘야합니다.

 

1. 프로젝스 설정 > 빌드 > 설명서 파일을 체크.

 

2. Program.cs 에 AddSwaggerGen 부분의 코드를 아래와 같은 형태로 변경

            builder.Services.AddSwaggerGen(options =>
            {
                // using System.Reflection;
                var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename));
            });