.NET Core Web API 애플리케이션에서 Swagger UI를 통합하는 방법 | 아메누스 데브

Swagger 도구를 사용하면 경로, 컨트롤러 및 모델에서 직접 작업을 탐색하고 테스트하기 위한 UI를 포함하여 아름다운 API 문서를 생성할 수 있습니다.
설정은 간단하지만 약간의 코드 변경이 필요합니다.
.NET Core Web API 프로젝트에 대한 swagger 통합을 활성화하려면 다음을 수행해야 합니다.

NuGet에서 Swashbuckle.AspNetCore 패키지 설치

Net Core Web API 애플리케이션의 Startup.cs 클래스를 변경하십시오.

OpenApiInfo

에 대한 using 문 추가

수정 Configure(IApplicationBuilder app, IWebHostEnvironment env)

수정 ConfigureServices(IServiceCollection services)

Startup.cs의 변경 사항

Swagger 설치

프로젝트 폴더에서 Swagger Nuget 패키지(이 인스턴스의 경우 6.1.4)를 설치합니다.

dotnet add package Swashbuckle.AspNetCore --version 6.1.4

문 사용

using Microsoft.OpenApi.Models;

ConfigureServices()에 대한 변경 사항

ConfigureServices() 메소드에서 다음을 추가해야 합니다.

services.AddMvc();
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo
    {
        Title = "My Awesome API",
        Version = "v1"
    });
});

Configure()에 대한 변경 사항

Configure() 메소드에서 다음을 추가해야 합니다.

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My Awesome API V1");
});

개발용으로만 활성화하는 것을 선호합니다.

if (env.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My Awesome API V1");
    });
}

회전을 위해 그것을 가지고 가기

이러한 모든 변경 후에 마침내 새로운 통합을 테스트할 준비가 되었습니다.

dotnet run

SwaggerUI를 보려면 탐색하십시오.

Note: your port may be different

보너스: 커스터마이징

이제 Swagger를 구성했으므로 기본 테마를 변경할 수 있습니다.
이 작업을 수행하는 방법을 배울 수 있습니다blog post.

질문이나 피드백이 있으셨나요? 댓글로 공유해주세요🤗