Microsoft MVP성태의 닷넷 이야기
.NET Framework: 1018. .NET Core Kestrel 호스팅 - Web API 추가 [링크 복사], [링크+제목 복사]
조회: 911
글쓴 사람
정성태 (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)
12615정성태4/26/2021353오류 유형: 712. Microsoft Live 로그인 - 계정을 선택하는(Pick an account) 화면에서 진행이 안 되는 문제
12614정성태4/24/2021686개발 환경 구성: 570. C# - Azure AD 인증을 지원하는 ASP.NET Core/5+ 웹 애플리케이션 예제 구성 [3]파일 다운로드1
12613정성태4/23/2021457.NET Framework: 1048. C# - ETW 이벤트의 Keywords에 속한 EventId 구하는 방법 (2) 관리 코드파일 다운로드1
12612정성태4/23/2021512.NET Framework: 1047. C# - ETW 이벤트의 Keywords에 속한 EventId 구하는 방법 (1) PInvoke파일 다운로드1
12611정성태4/22/2021467오류 유형: 711. 닷넷 EXE 실행 오류 - Mixed mode assembly is build against version 'v2.0.50727' of the runtime
12610정성태4/22/2021568.NET Framework: 1046. C# - 컴파일 시점에 참조할 수 없는 타입을 포함한 이벤트 핸들러를 Reflection을 이용해 구독하는 방법파일 다운로드1
12609정성태4/22/2021631.NET Framework: 1045. C# - 런타임 시점에 이벤트 핸들러를 만들어 Reflection을 이용해 구독하는 방법파일 다운로드1
12608정성태4/21/2021890.NET Framework: 1044. C# - Generic Host를 이용해 .NET 5로 리눅스 daemon 프로그램 만드는 방법 [7]파일 다운로드1
12607정성태4/21/2021606.NET Framework: 1043. C# - 실행 시점에 동적으로 Delegate 타입을 만드는 방법파일 다운로드1
12606정성태4/21/2021667.NET Framework: 1042. C# - enum 값을 int로 암시적(implicit) 형변환하는 방법? [2]파일 다운로드1
12605정성태4/18/2021532.NET Framework: 1041. C# - AssemblyID, ModuleID를 관리 코드에서 구하는 방법파일 다운로드1
12604정성태4/18/2021467VS.NET IDE: 163. 비주얼 스튜디오 속성 창의 "Build(빌드)" / "Configuration(구성)"에서의 "활성" 의미
12603정성태4/16/2021582VS.NET IDE: 162. 비주얼 스튜디오 - 상속받은 컨트롤이 디자인 창에서 지원되지 않는 문제
12602정성태4/16/2021729VS.NET IDE: 161. x64 DLL 프로젝트의 컨트롤이 Visual Studio의 Designer에서 보이지 않는 문제
12601정성태4/15/2021533.NET Framework: 1040. C# - REST API 대신 github 클라이언트 라이브러리를 통해 프로그래밍으로 접근
12600정성태4/15/2021608.NET Framework: 1039. C# - Kubeconfig의 token 설정 및 인증서 구성을 자동화하는 프로그램
12599정성태4/14/2021486.NET Framework: 1038. C# - 인증서 및 키 파일로부터 pfx/p12 파일을 생성하는 방법파일 다운로드1
12598정성태4/14/2021534.NET Framework: 1037. openssl의 PEM 개인키 파일을 .NET RSACryptoServiceProvider에서 사용하는 방법 (2)파일 다운로드1
12597정성태4/13/2021453개발 환경 구성: 569. csproj의 내용을 공통 설정할 수 있는 Directory.Build.targets / Directory.Build.props 파일
12596정성태4/12/2021570개발 환경 구성: 568. Windows의 80 포트 점유를 해제하는 방법
12595정성태4/12/2021472.NET Framework: 1036. SQL 서버 - varbinary 타입에 대한 문자열의 CAST, CONVERT 변환을 C# 코드로 구현
12594정성태4/11/2021606.NET Framework: 1035. C# - kubectl 명령어 또는 REST API 대신 Kubernetes 클라이언트 라이브러리를 통해 프로그래밍으로 접근 [1]파일 다운로드1
12593정성태4/10/2021569개발 환경 구성: 567. Docker Desktop for Windows - kubectl proxy 없이 k8s 대시보드 접근 방법
12592정성태4/10/2021493개발 환경 구성: 566. Docker Desktop for Windows - k8s dashboard의 Kubeconfig 로그인 및 Skip 방법
12591정성태4/9/2021877.NET Framework: 1034. C# - byte 배열을 Hex(16진수) 문자열로 고속 변환하는 방법파일 다운로드1
12590정성태4/9/2021523.NET Framework: 1033. C# - .NET 4.0 이하에서 Console.IsInputRedirected 구현
1  2  3  4  5  6  7  8  9  [10]  11  12  13  14  15  ...