ASP.NET 코어(36)는 Swagger 대신 스칼라를 사용하여 API 문서를 표시합니다

작은 쓰레기 같은 놈들 · 게시됨5분 전

요구사항: Scalar는 매우 강력하며, Swagger 대신 Scalar를 사용하여 API 문서에서 다양한 언어로 HTTP 호출 코드를 자동으로 생성할 수 있습니다.

.NET 9 출시 ASP.NET 공식 코어 팀은 Swashbuckle.AspNetCore(ASP.NET Core API용 Swagger 도구를 제공하는 프로젝트)를 ASP.NET Core Web API 템플릿에서 제거할 것이라고 발표했습니다. 이는 앞으로 웹 API 프로젝트를 만들 때 Swagger API 문서가 자동으로 생성되지 않는다는 뜻입니다. 그래서 오늘은 EasySQLite .NET 9 프로젝트에서 대화형 API 문서화를 위해 Scalar를 사용해 보겠습니다.

링크:하이퍼링크 로그인이 보입니다.

스웨거가 해임된 이유는 다음과 같이 요약할 수 있다:

Swashbuckle 열악한 유지보수: Swashbuckle 프로젝트는 더 이상 커뮤니티 소유자들에 의해 적극적으로 유지보수되지 않고 있으며, 많은 문제가 해결되지 않았고 .NET 8과 호환되는 공식 버전도 출시되지 않았습니다.
Microsoft.AspNetCore.OpenApi로 넘어가서: ASP.NET Core 팀은 Swashbuckle을 대체하고 OpenAPI 문서 생성을 가능하게 하는 Microsoft.AspNetCore.OpenApi의 역량을 강화할 것입니다.
기존 대안: Swashbuckle 외에도 NSwag 같은 프로젝트가 OpenAPI 문서 생성과 클라이언트/서버 코드 생성을 지원하여 개발자가 프로젝트 필요에 따라 적합한 솔루션을 선택할 수 있습니다.
향상된 내장 API 지원: Core 3.1부터 프레임워크는 ApiExplorer와 같은 메타데이터 지원을 제공 ASP.NET 있습니다. Visual Studio와 Visual Studio Code의 .http 파일 내장 지원과 결합되어, API 테스트 및 디버깅 경험이 더욱 향상되었습니다.
OpenAPI를 핵심 구성 요소로 홍보: ASP.NET Core 팀은 .NET 9에서 OpenAPI 통합을 더욱 강화하여 JSON 형식의 OpenAPI 문서 생성에 중점을 둔 핵심 구성 요소로 만들 계획입니다.

스칼라

스칼라는 강력하고 사용하기 쉬운 API 클라이언트 및 문서 생성 도구로, 모든 규모의 API 프로젝트에 적합하며 여러 프로그래밍 언어와 플랫폼을 지원합니다.

오픈 소스 주소:하이퍼링크 로그인이 보입니다.

ASP.NET 코어는 스칼라 통합을 지원합니다

통합 문서:하이퍼링크 로그인이 보입니다.

다음과 같이 참조된 ASP.NET Core 9 프로젝트를 만드세요:

로그인이 보이네요.

Program.cs에 서비스와 스칼라 미들웨어를 추가하며, 코드는 다음과 같습니다:

로그인이 보이네요.

컨트롤러WeatherForecastController.cs 수정, 코드는 다음과 같습니다:

로그인이 보이네요.

프로젝트를 실행하고 브라우저를 열어 다음을 방문하세요:http://localhost:5088/api-docs, 아래 그림에서 볼 수 있습니다:

다양한 언어로 HTTP 라이브러리에 대해 특정 호출 코드를 생성할 수 있습니다. C# HttpClient 라이브러리를 예로 들면, 생성된 코드는 다음과 같습니다:

온라인 인터페이스 테스트도 지원합니다. 테스트 요청 버튼을 클릭하고 게시물 데이터를 입력한 후 전송을 클릭하여 요청을 전송합니다. 아래 설명과 같습니다:

기본 HTTP 클라이언트를 커스터마이즈하세요. C# 팀의 경우, API 문서 인터페이스를 열고 자동으로 C# HttpClient 호출 코드를 표시하고자 합니다. 처음마다 수동으로 선택하고 싶지 않다면, 다음과 같이 구성하세요:

로그인이 보이네요.

Ask AI 기능을 삭제하고 Ask AI 에이전트 버튼을 제거하세요. 이 기능은 다소 중복된 느낌입니다. 코드는 다음과 같습니다:

로그인이 보이네요.

아래에 나와 있습니다:

삭제 후, 아래와 같이 :

마찬가지로, MCP 기능을 비활성화하고 코드는 다음과 같습니다:

로그인이 보이네요.

전체 구성은 다음과 같습니다:

로그인이 보이네요.

JWT 인증을 추가하고 요청 헤더를 전달합니다소지자 토큰

전체 OpenAPI 문서에 보안 요구사항을 추가하세요. 코드는 다음과 같습니다:

로그인이 보이네요.

아래에 나와 있습니다:

OpenID Connect (OIDC):하이퍼링크 로그인이 보입니다.

참조:

하이퍼링크 로그인이 보입니다.
하이퍼링크 로그인이 보입니다.

작은 쓰레기 같은 놈들 · 게시됨1분 전

블로그 게시물을 참고하세요

하이퍼링크 로그인이 보입니다.
하이퍼링크 로그인이 보입니다.

다른

하이퍼링크 로그인이 보입니다.

[ASP.NET] ASP.NET 코어(36)는 Swagger 대신 스칼라를 사용하여 API 문서를 표시합니다

관련 게시물