Microsoft MVP성태의 닷넷 이야기
.NET Framework: 1018. .NET Core Kestrel 호스팅 - Web API 추가 [링크 복사], [링크+제목 복사]
조회: 565
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

.NET Core Kestrel 호스팅 - Web API 추가

지금까지 콘솔 프로젝트로 시작해 Kestrel을 이용한 웹 애플리케이션 코드를 하나씩 추가해 봤는데요,

.NET Core 콘솔 프로젝트에서 Kestrel 호스팅 방법
; https://www.sysnet.pe.kr/2/0/12496

.NET Core Kestrel 호스팅 - 포트 변경, non-localhost 접속 지원 및 https 등의 설정 변경
; https://www.sysnet.pe.kr/2/0/12499

ASP.NET Core(Kestrel)의 HTTP/2 지원 여부
; https://www.sysnet.pe.kr/2/0/12500

이번에는 OWIN에서도 구현했던,

C# - OWIN Web API 예제 프로젝트
; https://www.sysnet.pe.kr/2/0/12497

Web API도 추가해 보겠습니다. (참고로, 기반 프로젝트는 ASP.NET Core(Kestrel)의 HTTP/2 지원 여부에 첨부한 예제 코드로 시작합니다.)




당연히 Web API 역할을 할 클래스를 추가해야 하고,

// 비주얼 스튜디오에서는 "API Controller - Empty" 항목을 추가해도 됩니다.

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace ConsoleApp1
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }
    }
}

이렇게 추가한 Controller를 서비스하도록 AddControllers 메서드와, 이에 대한 호출 경로를 자동으로 잡아주는 MapControllers를 추가하면 끝입니다.

// Program.cs

public class Startup
{
    public void ConfigureServices(IServiceCollection services) 
    {
        services.AddControllers(); 
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        app.UseRouting();
        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
            endpoints.MapGet("/", async context =>
            {
                await context.Response.WriteAsync("Hello World!");
            });
        });
    }
}

이후 빌드/실행하면 (이 글의 예제 프로젝트에서는) 이제 다음과 같은 경로로 Web API를 호출할 수 있습니다.

  • http://localhost:16000/api/values
  • https://localhost:16002/api/values




부가적으로, 개발의 편의성을 위한 작업을 하나 더 추가해보겠습니다. 일반적으로, 개발 환경에서는 자세한 오류 메시지를 보여주는 것이 디버깅을 위해서도 좋기 때문에 다음과 같은 코드를 추가할 수 있습니다.

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        Console.WriteLine("IsDevelopment");
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

이후 비주얼 스튜디오에서 실행하면 화면에 "IsDevelopment" 출력을 확인할 수 있습니다. 반면, 빌드 디렉터리로 이동 후 ConsoleApp1.exe를 직접 실행하면 저 문자열이 안 보입니다.

왜냐하면, 비주얼 스튜디오의 경우 실행 시 "Properties" / "launchSettings.json" 파일을 참조해 미리 환경 구성을 하기 때문입니다. 실제로 launchSettings.json 파일을 보면,

{
  "iisSettings": {
    "windowsAuthentication": false,
    "anonymousAuthentication": true,
    "iisExpress": {
      "applicationUrl": "http://localhost:15000/",
      "sslPort": 44338
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "ConsoleApp1": {
      "commandName": "Project",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      },
      "applicationUrl": "https://localhost:5001;http://localhost:5000"
    }
  }
}

환경 설정 값이 나오는데요, 따라서 ConsoleApp1.exe를 직접 실행하는 경우에도 저 동작을 흉내 내려면 이런 식으로 구동할 수 있습니다.

C:\temp> SET ASPNETCORE_ENVIRONMENT=Development

C:\temp> ConsoleApp1.exe
IsDevelopment
info: Microsoft.Hosting.Lifetime[0]
      Now listening on: http://[::]:16000
info: Microsoft.Hosting.Lifetime[0]
      Now listening on: http://[::]:16001
info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://[::]:16002
info: Microsoft.Hosting.Lifetime[0]
...[생략]...

그리고 이쯤 되면 눈치채셨겠지만, launchSettings.json 파일은 비주얼 스튜디오의 프로파일 설정과 직접적으로 연관됩니다.

.NET Core Kestrel 호스팅 - 비주얼 스튜디오의 Kestrel/IIS Express 프로파일 설정
; https://www.sysnet.pe.kr/2/0/12498

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




참고로, services.AddControllers(); 코드 없이 endpoints.MapControllers();만 호출하면 다음과 같은 식의 에러를 볼 수 있습니다.

System.InvalidOperationException
  HResult=0x80131509
  Message=Unable to find the required services. Please add all the required services by calling 'IServiceCollection.AddControllers' inside the call to 'ConfigureServices(...)' in the application startup code.
  Source=Microsoft.AspNetCore.Mvc.Core
  StackTrace:
   at Microsoft.AspNetCore.Builder.ControllerEndpointRouteBuilderExtensions.EnsureControllerServices(IEndpointRouteBuilder endpoints) in /_/src/Mvc/Mvc.Core/src/Builder/ControllerEndpointRouteBuilderExtensions.cs:line 581
   at Microsoft.AspNetCore.Builder.ControllerEndpointRouteBuilderExtensions.MapControllers(IEndpointRouteBuilder endpoints) in /_/src/Mvc/Mvc.Core/src/Builder/ControllerEndpointRouteBuilderExtensions.cs:line 33
   at WebApplication3.Startup.<>c.<Configure>b__1_0(IEndpointRouteBuilder endpoints) in C:\temp\ConsoleApp1\Startup.cs:line 34
   at Microsoft.AspNetCore.Builder.EndpointRoutingApplicationBuilderExtensions.UseEndpoints(IApplicationBuilder builder, Action`1 configure) in /_/src/Http/Routing/src/Builder/EndpointRoutingApplicationBuilderExtensions.cs:line 99
   at WebApplication3.Startup.Configure(IApplicationBuilder app, IWebHostEnvironment env) in C:\temp\ConsoleApp1\Startup.cs:line 32
   at System.RuntimeMethodHandle.InvokeMethod(Object target, Object[] arguments, Signature sig, Boolean constructor, Boolean wrapExceptions)
   at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture) in /_/src/coreclr/src/System.Private.CoreLib/src/System/Reflection/RuntimeMethodInfo.cs:line 399
   at Microsoft.AspNetCore.Hosting.ConfigureBuilder.Invoke(Object instance, IApplicationBuilder builder) in /_/src/Hosting/Hosting/src/Internal/ConfigureBuilder.cs:line 31
   at Microsoft.AspNetCore.Hosting.ConfigureBuilder.<>c__DisplayClass4_0.<Build>b__0(IApplicationBuilder builder) in /_/src/Hosting/Hosting/src/Internal/ConfigureBuilder.cs:line 20
   ...[생략]...
   at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Run(IHost host) in /_/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostingAbstractionsHostExtensions.cs:line 51
   at WebApplication3.Program.Main(String[] args) in C:\temp\ConsoleApp1\Program.cs:line 16

  This exception was originally thrown at this call stack:
    Microsoft.AspNetCore.Builder.ControllerEndpointRouteBuilderExtensions.EnsureControllerServices(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder) in ControllerEndpointRouteBuilderExtensions.cs
    Microsoft.AspNetCore.Builder.ControllerEndpointRouteBuilderExtensions.MapControllers(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder) in ControllerEndpointRouteBuilderExtensions.cs
    WebApplication3.Startup.Configure.AnonymousMethod__1_0(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder) in Startup.cs
    Microsoft.AspNetCore.Builder.EndpointRoutingApplicationBuilderExtensions.UseEndpoints(Microsoft.AspNetCore.Builder.IApplicationBuilder, System.Action<Microsoft.AspNetCore.Routing.IEndpointRouteBuilder>) in EndpointRoutingApplicationBuilderExtensions.cs
    WebApplication3.Startup.Configure(Microsoft.AspNetCore.Builder.IApplicationBuilder, Microsoft.AspNetCore.Hosting.IWebHostEnvironment) in Startup.cs
    Microsoft.AspNetCore.Hosting.ConfigureBuilder.Invoke(object, Microsoft.AspNetCore.Builder.IApplicationBuilder) in ConfigureBuilder.cs
    Microsoft.AspNetCore.Hosting.ConfigureBuilder.Build.AnonymousMethod__0(Microsoft.AspNetCore.Builder.IApplicationBuilder) in ConfigureBuilder.cs
    Microsoft.AspNetCore.Hosting.GenericWebHostBuilder.UseStartup.AnonymousMethod__1(Microsoft.AspNetCore.Builder.IApplicationBuilder) in GenericWebHostBuilder.cs
    Microsoft.AspNetCore.HostFilteringStartupFilter.Configure.AnonymousMethod__0(Microsoft.AspNetCore.Builder.IApplicationBuilder) in HostFilteringStartupFilter.cs
    Microsoft.AspNetCore.Hosting.GenericWebHostService.StartAsync(System.Threading.CancellationToken) in GenericWebHostedService.cs
    ...
    [Call Stack Truncated]




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

[연관 글]


donaricano-btn



[최초 등록일: ]
[최종 수정일: 1/27/2021 ]

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

비밀번호

댓글 쓴 사람
 



2021-03-12 09시30분
What every ASP.NET Core Web API project needs - Part 1 - Serilog
; https://dev.to/moesmp/what-every-asp-net-core-web-api-project-needs-part-1-serilog-o5a

What every ASP.NET Core Web API project needs - Part 2 - API versioning and Swagger
; https://dev.to/moesmp/what-every-asp-net-core-web-api-project-needs-part-2-api-versioning-and-swagger-3nfm

What every ASP.NET Core Web API project needs - Part 3 - Exception handling middleware
; https://dev.to/moesmp/what-every-asp-net-core-web-api-project-needs-part-3-exception-handling-middleware-3nif
정성태

[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12674정성태6/15/20217VC++: 142. DEFINE_GUID 사용법
12673정성태6/15/20219Java: 19. IntelliJ - 자바(Java)로 만드는 Web App을 Tomcat에서 실행하는 방법
12672정성태6/15/20216오류 유형: 725. IntelliJ에서 Java webapp 실행 시 "Address localhost:1099 is already in use" 오류
12671정성태6/15/20217오류 유형: 724. Tomcat 실행 시 Failed to initialize connector [Connector[HTTP/1.1-8080]] 오류
12670정성태6/14/202148.NET Framework: 1071. DLL Surrogate를 이용한 Out-of-process COM 개체에서의 CoInitializeSecurity 문제파일 다운로드1
12669정성태6/12/202197.NET Framework: 1070. 사용자 정의 GetHashCode 메서드 구현은 C# 9.0의 record 또는 리팩터링에 맡기세요.
12668정성태6/13/202184.NET Framework: 1069. C# - DLL Surrogate를 이용한 Out-of-process COM 개체 제작파일 다운로드2
12667정성태6/13/202163.NET Framework: 1068. COM+ 서버 응용 프로그램을 이용해 CoInitializeSecurity 제약 해결파일 다운로드1
12666정성태6/10/202159.NET Framework: 1067. 별도 DLL에 포함된 타입을 STAThread Main 메서드에서 사용하는 경우 CoInitializeSecurity 자동 호출파일 다운로드1
12665정성태6/14/202167.NET Framework: 1066. Wslhub.Sdk 사용으로 알아보는 CoInitializeSecurity 사용 제약파일 다운로드1
12664정성태6/9/202143오류 유형: 723. COM+ PIA 참조 시 "This operation failed because the QueryInterface call on the COM component" 오류
12663정성태6/9/202192.NET Framework: 1065. Windows Forms - 속성 창의 디자인 설정 지원: 문자열 목록 내에서 항목을 선택하는 TypeConverter 제작파일 다운로드1
12662정성태6/8/2021110.NET Framework: 1064. C# COM 개체를 PIA(Primary Interop Assembly)로써 "Embed Interop Types" 참조하는 방법파일 다운로드1
12661정성태6/4/2021239.NET Framework: 1063. C# - MQTT를 이용한 클라이언트/서버(Broker) 통신 예제 [2]파일 다운로드1
12660정성태6/3/2021178.NET Framework: 1062. Windows Forms - 폼 내에서 발생하는 마우스 이벤트를 자식 컨트롤 영역에 상관없이 수신하는 방법 [1]파일 다운로드1
12659정성태6/2/202178Linux: 40. 우분투 설치 후 MBR 디스크 드라이브 여유 공간이 인식되지 않은 경우 - Logical Volume Management
12658정성태6/2/2021131Windows: 194. Microsoft Store에 있는 구글의 공식 Youtube App
12657정성태6/2/2021239Windows: 193. 윈도우 패키지 관리자 - winget 설치
12656정성태6/1/202178.NET Framework: 1061. 서버 유형의 COM+에 적용할 수 없는 Server GC
12655정성태6/1/202175오류 유형: 722. windbg/sos - savemodule - Fail to read memory
12654정성태5/31/202194오류 유형: 721. Hyper-V - Saved 상태의 VM을 시작 시 오류 발생
12653정성태5/31/2021185.NET Framework: 1060. 닷넷 GC에 새롭게 구현되는 DPAD(Dynamic Promotion And Demotion for GC)
12652정성태5/31/202193VS.NET IDE: 164. Visual Studio - Web Deploy로 Publish 시 암호창이 매번 뜨는 문제
12651정성태5/31/2021101오류 유형: 720. PostgreSQL - ERROR: 22P02: malformed array literal: "..."
12650정성태5/17/2021107기타: 82. OpenTabletDriver의 버튼에 더블 클릭을 매핑 및 게임에서의 지원 방법
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...