소개

WEBAPI가 있고 해당 API의 문서를 자동으로 업데이트하고 싶다고 가정해 보겠습니다. swagger 및 Redoc과 같은 프레임워크는 둘 다 빠르고 쉬운 설정을 위해 Visual Studio IDE 내에서 사용할 수 있는 너겟 패키지를 가지고 있으므로 좋은 접근 방식일 수 있습니다.

설정

WebAPI 프로젝트를 마우스 오른쪽 버튼으로 클릭하고 Nuget 패키지 관리를 클릭하여 다음 패키지를 설치합니다.

Swashbuckle.AspNetCore

Swashbuckle.AspNetCore.Swagger

Swashbuckle.AspNetCore.ReDoc

스웨거 구성

Starup.cs 파일에서 ConfigureServices 메서드에 SwagerGen을 포함합니다.

public void ConfigureServices(IServiceCollection services)
{
   services.AddSwaggerGen(c =>
   {
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApiDevoTo", Version = "v1" });
   });
}

Configure 메서드에 미들웨어를 포함합니다.

 public void Configure(IApplicationBuilder app, 
                       IWebHostEnvironment env)
{
   app.UseSwagger();
   app.UseSwaggerUI(c => 
   c.SwaggerEndpoint("/swagger/v1/swagger.json", 
                     "WebApiDevoTo v1"));
}

애플리케이션을 실행하고 뷰와 컨트롤러가 있는 새 WebAPI 프로젝트를 만든 경우 아래 그림과 같이 일기 예보를 사용할 수 있어야 합니다.

레독 구성

Configure 메서드에 ReDoc 미들웨어를 포함합니다.

 public void Configure(IApplicationBuilder app, 
                       IWebHostEnvironment env)
{           
  app.UseReDoc(c =>
  {
    c.DocumentTitle = "REDOC API Documentation";
    c.SpecUrl = "/swagger/v1/swagger.json";
  });           
}

기본적으로 애플리케이션을 실행하면 swagger 인터페이스가 표시됩니다. {localhost}/api-docs로 이동하여 아래 그림과 같이 ReDoc 인터페이스를 확인합니다.



ReDoc을 기본적으로 실행하려면 WebApi의 시작 브라우저를 api-docs로 설정하고 WebApi 프로젝트 > 속성 > 디버그를 마우스 오른쪽 버튼으로 클릭합니다.

Swagger X ReDoc [무료버전]

멋진
ReDoc


오픈 소스
예
예

OpenAPI 사양
예
예

임베디드 HTML/CSS/JS 허용
예
예

체험해보기 기능
예
아니

사이드바가 있는 레이아웃(3개 패널)
아니
예

결론

애플리케이션을 신속하게 노출하려면 ReDoc 및 Swagger와 같은 API 프레임워크가 확실히 빠르고 실용적인 솔루션입니다. Swagger와 ReDoc은 모두 무료 및 유료 버전을 제공하며 사용자의 요구 사항을 조정하기 위해 탐색해야 합니다. API를 문서화하는 데 사용하는 리소스에 대해 의견을 말하십시오.

참조

Swagger

ReDoc