[ASP.NET Core] WebApi with Swagger - 1. API 설명 추가하기 - 2

주석을 통한 Swagger 문서화는 해당 데이터를 주고받는 DTO 모델에도 적용 가능하다. WeatherForecast DTO모델 클래스에 아래와 같이 주석을 달아준다.

/// <summary>
/// 날짜입니다.
/// </summary>
/// <value></value>
/// <example>2021-08-01T00:00:00</example>
public DateTime Date { get; set; }

/// <summary>
/// 섭씨온도입니다.
/// </summary>
/// <value></value>
/// <example>42</example>
public int TemperatureC { get; set; }

/// <summary>
/// 화씨온도입니다.
/// </summary>
/// <returns></returns>
/// <example>107</example>
public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);

/// <summary>
/// 날씨 내용입니다.
/// </summary>
/// <value></value>
/// <example>Freezing</example>
public string? Summary { get; set; }

그 다음 소스를 재실행하면 Swagger ExampleValue 및 Schema 영역에 주석으로 작성한 설명 문구와 예제값이 반영된 것을 확인할 수 있다.

 

example 주석 값이 반영된 문서

스키마에 추가된 설명문구