소개

  • 2분

내가 빌드하는 소프트웨어를 문서화하는 데는 많은 이점이 있습니다. 충실히 작성된 문서는 시간이 흐른 뒤에도 코드를 효율적으로 관리할 수 있도록 도와줄 뿐 아니라 다른 사람들도 쉽게 사용할 수 있도록 지원합니다. 다른 사람들이 사용하고자 하는 API의 경우에는 코드를 사용하기 쉽게 만드는 것이 특히 더 중요합니다. 다행히 양질의 문서를 생성하는 데 필요한 비용을 줄여주는 몇 가지 도구와 프레임워크가 있습니다.

여러분이 인쇄 프레이밍 회사에서 수석 개발자로 일하고 있다고 가정해 보겠습니다. 회사에서 자체 API를 공개하기로 결정했습니다. 기존에 문서가 없는 API가 많아서 여러분이 이를 문서화하는 일을 맡게 되었습니다. API를 문서화하면 파트너들이 API를 올바르게 사용할 수 있게 되어 지원 비용과 유지 관리 비용이 절약될 것으로 기대됩니다.

각 API를 문서화하는 쉽고 표준화된 방법이 필요합니다. 파트너를 위해 액세스할 수 있는 위치에서 설명서를 호스트하는 방법도 필요합니다.

이 모듈에서는 Swashbuckle, Swagger, Swagger UI 및 OpenAPI를 사용하여 기존의 ASP.NET Core API를 문서화하는 방법을 알아봅니다.

학습 목표

이 모듈에서 학습할 내용은 다음과 같습니다.

  • Swashbuckle, OpenAPI 및 Swagger UI에 대해 알아봅니다.
  • C#/ASP.NET Core API에 대한 OpenAPI를 활성화합니다.
  • C#/ASP.NET Core API에서 Swashbuckle을 사용합니다.
  • OpenAPI를 사용하여 API 설명서를 생성하고 봅니다.

전제 조건