ASP.Net Core에서 NSwag 사용하기

---

사용 이유

Swagger UI 및 Rest API 생성기를 사용하여 유연한 코드 생성 및 관리가 가능하다.

 

설치

컴파일러 환경 : Visual Studio 2019

NuGet 패키지 관리 대화 상자에서, "NSwag.AspNetCore 설치

 

서비스 등록

ASP.Net Core 앱에서 Swagger를 추가한다.

• Startup.ConfigureService 메서드에서 필수 Swagger서비스 등록

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<TodoContext>(opt =>
        opt.UseInMemoryDatabase("TodoList"));
    services.AddMvc();

    // Register the Swagger services
    services.AddSwaggerDocument();
}

 

• Startup.Configure 메서드에서 생성된 Swagger사양 및 Swagger UI를 지원하기 위해 미들웨어 사용하도록 설정

public void Configure(IApplicationBuilder app)
{
    app.UseStaticFiles();

    // Register the Swagger generator and the Swagger UI middlewares
    app.UseOpenApi();
    app.UseSwaggerUi3();

    app.UseMvc();
}

 

• 앱 시작하여 다음으로 이동
  • http://localhost:<port>/swagger - Swagger UI를 확인할 수 있다.
  • http://localhost<port>/swagger/v1/swagger.json - Swagger 사양을 확인할 수 있다.

 

참고

• NSwag 및 ASP.NET Core 시작