Microsoft MVP성태의 닷넷 이야기
닷넷: 2193. C# - ASP.NET Web Application + OpenAPI(Swashbuckle) 스펙 제공 [링크 복사], [링크+제목 복사],
조회: 14585
글쓴 사람
정성태 (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

비밀번호

댓글 작성자
 




... 31  32  33  34  35  [36]  37  38  39  40  41  42  43  44  45  ...
NoWriterDateCnt.TitleFile(s)
13145정성태10/21/202219458오류 유형: 822. db2 - Password validation for user db2inst1 failed with rc = -2146500508
13144정성태10/20/202220483.NET Framework: 2059. ClrMD를 이용해 윈도우 환경의 메모리 덤프로부터 닷넷 모듈을 추출하는 방법파일 다운로드1
13143정성태10/19/202221295오류 유형: 821. windbg/sos - Error code - 0x000021BE
13142정성태10/18/202232622도서: 시작하세요! C# 12 프로그래밍
13141정성태10/17/202221251.NET Framework: 2058. [in,out] 배열을 C#에서 C/C++로 넘기는 방법 - 세 번째 이야기파일 다운로드1
13140정성태10/11/202221285C/C++: 159. C/C++ - 리눅스 환경에서 u16string 문자열을 출력하는 방법 [2]
13139정성태10/9/202218039.NET Framework: 2057. 리눅스 환경의 .NET Core 3/5+ 메모리 덤프로부터 모든 닷넷 모듈을 추출하는 방법파일 다운로드1
13138정성태10/8/202221119.NET Framework: 2056. C# - await 비동기 호출을 기대한 메서드가 동기로 호출되었을 때의 부작용 [1]
13137정성태10/8/202220693.NET Framework: 2055. 리눅스 환경의 .NET Core 3/5+ 메모리 덤프로부터 닷넷 모듈을 추출하는 방법
13136정성태10/7/202219364.NET Framework: 2054. .NET Core/5+ SDK 설치 없이 dotnet-dump 사용하는 방법
13135정성태10/5/202221104.NET Framework: 2053. 리눅스 환경의 .NET Core 3/5+ 메모리 덤프를 분석하는 방법 - 두 번째 이야기 [1]
13134정성태10/4/202215821오류 유형: 820. There is a problem with AMD Radeon RX 5600 XT device. For more information, search for 'graphics device driver error code 31'
13133정성태10/4/202218598Windows: 211. Windows - (commit이 아닌) reserved 메모리 사용량 확인 방법 [1]
13132정성태10/3/202218001스크립트: 42. 파이썬 - latexify-py 패키지 소개 - 함수를 mathjax 식으로 표현
13131정성태10/3/202222298.NET Framework: 2052. C# - Windows Forms의 데이터 바인딩 지원(DataBinding, DataSource) [2]파일 다운로드1
13130정성태9/28/202218802.NET Framework: 2051. .NET Core/5+ - 에러 로깅을 위한 Middleware가 동작하지 않는 경우파일 다운로드1
13129정성태9/27/202219192.NET Framework: 2050. .NET Core를 IIS에서 호스팅하는 경우 .NET Framework CLR이 함께 로드되는 환경
13128정성태9/23/202222520C/C++: 158. Visual C++ - IDL 구문 중 "unsigned long"을 인식하지 못하는 #import [1]파일 다운로드1
13127정성태9/22/202220097Windows: 210. WSL에 systemd 도입
13126정성태9/15/202220334.NET Framework: 2049. C# 11 - 정적 메서드에 대한 delegate 처리 시 cache 적용
13125정성태9/14/202220733.NET Framework: 2048. C# 11 - 구조체 필드의 자동 초기화(auto-default structs)
13124정성태9/13/202221148.NET Framework: 2047. Golang, Python, C#에서의 CRC32 사용
13123정성태9/8/202221204.NET Framework: 2046. C# 11 - 멤버(속성/필드)에 지정할 수 있는 required 예약어 추가
13122정성태8/26/202222220.NET Framework: 2045. C# 11 - 메서드 매개 변수에 대한 nameof 지원
13121정성태8/23/202216081C/C++: 157. Golang - 구조체의 slice 필드를 Reflection을 이용해 변경하는 방법
13120정성태8/19/202221524Windows: 209. Windows NT Service에서 UI를 다루는 방법 [3]
... 31  32  33  34  35  [36]  37  38  39  40  41  42  43  44  45  ...