Microsoft MVP성태의 닷넷 이야기
닷넷: 2193. C# - ASP.NET Web Application + OpenAPI(Swashbuckle) 스펙 제공 [링크 복사], [링크+제목 복사],
조회: 9950
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 
(연관된 글이 1개 있습니다.)
(시리즈 글이 2개 있습니다.)
.NET Framework: 1028. 닷넷 5 환경의 Web API에 OpenAPI 적용을 위한 NSwag 또는 Swashbuckle 패키지 사용
; https://www.sysnet.pe.kr/2/0/12559

닷넷: 2193. C# - ASP.NET Web Application + OpenAPI(Swashbuckle) 스펙 제공
; https://www.sysnet.pe.kr/2/0/13511




C# - ASP.NET Web Application + OpenAPI(Swashbuckle) 스펙 제공

테스트를 위해 ASP.NET Web Application (.NET Framework) 프로젝트를 Web API 유형으로 생성합니다. 그럼, App_Start 디렉터리에 각종 Config 파일들이 놓이고 이들은 Global.asax.cs의 Application_Start 시점에 호출이 되도록 구성됩니다.

이 상태에서는 그냥 F5 실행 후, ValuesController를 다음의 경로로 호출할 수 있습니다.

[호출]
http://localhost:2289/api/Values

[응답]
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<string>value1</string>
<string>value2</string>
</ArrayOfstring>

자, 그럼 ValuesController를 OpenAPI 스펙을 이용해 노출해 볼 텐데요, 이에 대해서는 아래의 글에서 잘 설명하고 있습니다.

Swagger For .NET MVC Web API
; https://www.c-sharpcorner.com/article/swagger-for-net-mvc-web-api/

이에 따라 패키지 참조를 하면,

Install-Package Swashbuckle

프로젝트에는 App_Start 디렉터리 밑에 SwaggerConfig.cs 파일이 다음의 내용으로 추가됩니다.

using System.Web.Http;
using WebActivatorEx;
using WebApplication2;
using Swashbuckle.Application;

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

namespace WebApplication2
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "WebApplication2");
                    })
                .EnableSwaggerUi(c =>
                    {
                    });
        }
    }
}

이 외에, 딱히 더 해줄 것은 없습니다. 나머지는 Swashbuckle 라이브러리가 Assembly 내의 Controller를 뒤져 자동으로 OpenAPI Spec에 추가하는 작업을 위의 Register 코드로 해주기 때문입니다. 이제 다음의 URL로 실행해 주면,

http://localhost:2289/Swagger

예전에 .NET 5 환경에서 실습했던 것처럼 OpenAPI 스펙을 구현한 웹 화면이 뜹니다.

swagger_aspnet_fx_1.png

이후의 모든 사용법은 "Add Connected Service"를 설명했던 것과 동일합니다.




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 1/4/2024]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




... 166  167  168  169  170  171  172  173  174  175  176  177  178  [179]  180  ...
NoWriterDateCnt.TitleFile(s)
511정성태6/25/200729768.NET Framework: 90. XmlSerializer 생성자의 실행 속도를 올리는 방법 [2]
510정성태6/25/200744788디버깅 기술: 15. First-Chance Exception
508정성태6/21/200727775Team Foundation Server: 18. Team Build에 사용되는 각종 Property 값 [4]
507정성태6/11/200725379VS.NET IDE: 50. Orcas - UAC 설정 관련
506정성태6/9/200720395오류 유형: 39. VC Package not available or not registered
505정성태6/9/200720067오류 유형: 38. Visual SourceSafe - DB 잠김 오류
504정성태6/9/200725387오류 유형: 37. Visual SourceSafe - Anaylze 도중 비정상 종료
503정성태6/7/200728176VS.NET IDE: 49. Orcas - VC++ 다중 소스 동시 컴파일 옵션: /MP
502정성태6/7/200722813VS.NET IDE: 48. Orcas - VC++ 프로젝트 마이그레이션
500정성태6/4/200731468VS.NET IDE: 47. Orcas - Web Browser Debugger를 이용한 보호 모드의 ActiveX 컨트롤 디버깅
499정성태6/3/200724289VS.NET IDE: 46. Orcas - ComUtil로 인한 증분(/INCREMENTAL) 링크 옵션 사용 제한파일 다운로드1
498정성태5/31/200718700Windows: 26. 스마트 카드 암호 바꾸는 방법.
497정성태5/31/200722049오류 유형: 36. SQL 2005 - DB 속성창 띄울 때 오류
496정성태5/29/200720001VS.NET IDE: 45. VS.NET 2005/Orcas 솔루션 파일과 UAC
495정성태5/28/200722534VS.NET IDE: 44. Orcas와 VS.NET 2005의 혼합 개발 [1]
494정성태5/26/200726770오류 유형: 35. 비스타 탐색기 - 특정 파일을 오른쪽 마우스 클릭했을 때, 비정상 종료되는 문제
493정성태5/26/200725870오류 유형: 34. Windows Server 2008 : CA 인증서 발급 실패
492정성태5/23/200725447.NET Framework: 89. ManagedThreadId - 두 번째 이야기 [5]파일 다운로드1
491정성태5/21/200725484.NET Framework: 88. ManagedThreadId ? [4]
490정성태5/19/200733996오류 유형: 33. error MSB6003: SxS DLL 로딩 오류 [2]
489정성태5/14/200721836.NET Framework: 87. .NET 2.0에서 C# 3.0 기능 사용하기
488정성태5/14/200720462Windows: 25. Multiple Input Queues
487정성태4/24/200725935VC++: 32. VC++에서 bool이 가지는 의미 [3]
486정성태3/22/200724974Windows: 24. DreamScene과 DWM(Desktop Window Manager)의 관계 [1]
485정성태3/17/200720405오류 유형: 32. VS.NET 2005 - x64 환경에서의 mixed 디버깅 환경 구성
484정성태3/17/200719509오류 유형: 31. SQL Compact Edition 설치 후 오류
... 166  167  168  169  170  171  172  173  174  175  176  177  178  [179]  180  ...