[ASP.NET Core] WebAPI 구축하기.


ASP.NET Core WebAPI 를 구축하면서 어려움을 느꼈던 부분을 풀어 보겠습니다.


제가 이야기 하는 내용은 제가 공부하면서 알게된 내용을 정리한 것으로 개념을 잡는데 도움이 되리라 생각합니다.

다른 여러 Article 을 보시게 되면 더 많은 내용을 추가하실수 있을 겁니다.


그럼 Project 를 생성하면서 시작해 보겠습니다.




ASP.NET Core WebApplication Template 을 선택합니다.



나타나는 창에서 API 를 선택하고요. .NET 의 버전은 .NET Core 의 ASP.NET Core 2.1 을 사용하도록 하겠습니다.



OK 를 클릭하면 Project 를 생성합니다.



그럼 초기화면이 나타나지요.



생성된 폴더와 파일들 중에서 Properties 폴더를 열어서 launchSettings.json 을 클릭하여 열어봅니다.

이 파일에는 IIS Express 에 대한 내용이 들어 있습니다.

이 Project 의 경우에는 62148 port 를 사용하겠다고 적혀 있네요.


이번 Service 를 구축하면서 HTTPS 설정이 들어 갈텐데요. 

그 정보에 대한 내용을 이야기 할 때 다시한번 살펴보겠습니다.



이젠 Startup.cs 파일을 살펴보겠습니다.



Startup 클래스는 application 이 실행하면서 필요한 service 와 application 의 request pipeline 을 구성합니다.


이곳에는 Startup class 의 Constructor 와 두개의 중요한 Method 가 있습니다.


두 Method 의 역할은 주석에 간단하게 나타나 있습니다.

ConfigureServices Method 는 Application 에서 사용할 Service 를 Container 에 추가하는 곳입니다.

Configure Method 에서는 HTTP Request pipeline 을 구성합니다.


ASP.NET Core 에서는 기본적으로 Dependency Injection 을 지원합니다.



상단에 보시면 using Microsoft.Extentions.DependencyInjection; 을 보실 수 있는데 이 Namespace 내의 Extention Method 를 통해서 Service 를 등록할 수 있게 합니다.


ConfigurationServices Method 를 보시면 기본적으로 services.AddMvc() 가 추가되어 있는 걸 보실 수 있습니다

이 구문을 통해 Razor Page 와 MVC Request 를 처리할 수 있게 합니다.


Configure Method 에는  HTTP Request pipeline 을 구성한다고 했는데

수신된 Request 를 처리하는 순서대로 Middleware 를 추가합니다.




ConfigurationService Method 에 한가지 Setting 을 하려고 합니다.

ASP.NET Core 의 routing Middleware 는 controller name 을 rendering 할 때 Pascal Case 를 사용하는데요.

URL 에 lowercase 로 rendering 되도록 하려합니다.



주석을 영문, 한글로 다 달아 봤는데요. 

영어가 짧더라도 이해해 주시고요. 많이 어색하면 알려주셔요. 고치도록 하겠습니다. ^^;


그리고 마지막으로 중요한 사항인데요.

ConfigurationServices Method 의 경우 추가되는 Service 의 순서는 중요하지 않지만.

Configure Method 의 경우는 수신된 Request 가 처리되는 Pipeline 을 구성하는 것이므로 순서가 아주 중요하다는 것을 기억하시기 바랍니다.


간단간단하게 구성하며 정리를 하려했는데...

언제나 그렇지만 적어 내려가면서 계속 내용이 늘어나네요...


Series 가 좀 늘어날 수도 있으리라 생각이 들긴합니다. ^^;


다음 글에서는 Controller 를 추가해가면서 Test 를 진행해 보도록 하겠습니다.


Source


행복한 고수되셔요.


woojja ))*

\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\








Posted by woojja


REST API 의 예제를 보면 여러 Parameter 를 사용하는 Method 를 볼 수있습니다.

간단히? 되리라 생각하지만 턱 하니 막히기도 하지요.


예제를 보면 아래와 같이 Method 에 사용하는 Multiple Parameter 지만 에 일반 Parameter 와 [FromBody] Attribute 를 달고 있는 Parameter 를 한꺼번에 사용하는 녀석을 만날 수 있습니다. 


// PUT api/values/5
        public void Put(int id, [FromBody]string value)
        {
        }

 ASP.NET Core 로 개발 중 위와 같은 Method 를 Postman 에서 테스트하는 중 Value 에 값이 Null 로 들어오는 것을 발견했습니다. 




Postman 에서 Test 시 요로케 입력하면 되는군요... ㅋㅋㅋ



구글링하다 알게 되었네요...




행복한 고수되셔요...


woojja ))*

\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\






Posted by woojja


RestAPI 호출시 발생한 ajax Error 0




문제는 CORS 설정때문이었다.


Cors 에 대한 내용을 추가해주자...



Startup.cs


    public class Startup

    {

        public IConfiguration Configuration { get; set; }


        public Startup(IConfiguration configuration)

        {

            Configuration = configuration;

        }


        // This method gets called by the runtime. Use this method to add services to the container.

        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940

        public void ConfigureServices(IServiceCollection services)

        {

            // services.AddMvc(); 보다 앞에 위치 시킨다. (이건 Test 해보지 않았다. ^^;)

            services.AddCors();


            services.AddMvc();


            services.AddDataAccess();

            services.AddBusinessLogics();


            var configBuilder = new ConfigurationBuilder()

               .SetBasePath(Directory.GetCurrentDirectory())

               .AddJsonFile("appsettings.json", optional: true);

            var config = configBuilder.Build();


            services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

        }


        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.

        public void Configure(IApplicationBuilder app, IHostingEnvironment env, IServiceProvider serviceProvider)

        {

            if (env.IsDevelopment())

            {

                app.UseDeveloperExceptionPage();

            }


            // app.UseMvc(); 보다 앞에 위치 시킨다.

            app.UseOptions();


            //app.UseCors(builder => 

            //    builder.AllowAnyOrigin()

            //    .AllowCredentials()

            //    .AllowAnyHeader()

            //    .AllowAnyMethod()

            //    //.WithMethods("POST,GET,PUT,PATCH,DELETE,OPTIONS")

            //);


            //app.UseCors(builder =>


            //    //builder.AllowAnyOrigin().AllowAnyMethod()

            //    //.WithHeaders(HeaderNames.ContentType, "Authorization", "X-Requested-With")

            

//    builder.WithOrigins("*")

            //    //.AllowAnyOrigin()

            //    .AllowCredentials()

            //    .WithMethods("POST,GET,PUT,PATCH,DELETE,OPTIONS")

            //    .AllowAnyHeader()

            //    //.WithHeaders("Authorization", "X-Requested-With")

            //    );


            app.UseMvc();


            app.UseMvcWithDefaultRoute();


        }

    }



OptionsMiddleware.cs

    public static class OptionsMiddlewareExtensions

    {

        public static IApplicationBuilder UseOptions(this IApplicationBuilder builder)

        {

            return builder.UseMiddleware<OptionsMiddleware>();

        }

    }


    public class OptionsMiddleware

    {

        private readonly RequestDelegate _next;

        private IHostingEnvironment _environment;


        public OptionsMiddleware(RequestDelegate next, IHostingEnvironment environment)

        {

            _next = next;

            _environment = environment;

        }


        public async Task Invoke(HttpContext context)

        {

            this.BeginInvoke(context);

            await this._next.Invoke(context);

        }


        private async void BeginInvoke(HttpContext context)

        {

            //context.Response.Headers.Add("Access-Control-Allow-Origin", new[] { "*" });

            ////context.Response.Headers.Add("Access-Control-Allow-Origin", new[] { "*", (string)context.Request.Headers["Origin"] });

            ////context.Response.Headers.Add("Access-Control-Allow-Headers", new[] { "Origin, X-Requested-With, Content-Type, Content-Type: application/json, Accept, Accept: application/json, Authorization" });

            //context.Response.Headers.Add("Access-Control-Allow-Headers", new[] { "*" });

            //context.Response.Headers.Add("Access-Control-Allow-Methods", new[] { "GET, POST, PUT, DELETE, OPTIONS" });

            //context.Response.Headers.Add("Access-Control-Allow-Credentials", new[] { "true" });


            context.Response.Headers.Add("Access-Control-Allow-Origin", "*");

            context.Response.Headers.Add("Access-Control-Allow-Credentials", "true");

            // Added "Accept-Encoding" to this list

            //context.Response.Headers.Add("Access-Control-Allow-Headers", new[] { "*" });

            context.Response.Headers.Add("Access-Control-Allow-Headers", "Authorization, Content-Type, X-Requested-With, Accept, Accept-Version, Accept-Encoding, Content-Encoding, Content-Length, Content-MD5, Date, X-Api-Version, X-File-Name");

            context.Response.Headers.Add("Access-Control-Allow-Methods", "POST,GET,PUT,PATCH,DELETE,OPTIONS");


            if (context.Request.Method == "OPTIONS")

            {

                //context.Response.StatusCode = 200;

                //await context.Response.WriteAsync("OK");


                context.Response.StatusCode = (int)HttpStatusCode.OK;

                await context.Response.WriteAsync(string.Empty);

            }


        }

    }



Startup.cs 에서 


            .AllowAnyMethod() 대신 


            .WithMethods("POST,GET,PUT,PATCH,DELETE,OPTIONS") 로 변경해 보았는데.



Origin 과는 전혀 상관없는 오류가 발생했다. ㅡㅡ;

그렇다면 모든 Methos 를 열어줘야 한다는 이야기가 되는데... 그럼 안되겠죠? ㅋㅋ


그래서 app.UseCors(....) 를 사용하지 않고 위에 적어 놓은 Middleware 를 사용하기로 결정했다. 

Origins 의 경우는  Test 를 거쳐 변경할 예정이다.

Headers 의 경우도 현재는 Authorization, Content-Type, X-Requested-With 만 필요하지만 일단 다른 Header 들도 추가해 놓은 상태다.



ASP.NET Core 의 경우 ASP.NET 보다 유연하겠구나 라는 생각이 들긴하지만 서비스 내용을 바탕으로 설정해줘야 할 것들을 숙지하고 해둬야 하겠다.


이젠 WebSocket 을 붙여야 하는 상황인데...

Test 를 해보니 Socket 으로 가야할 녀석이 Controller 로 Routing 되는 걸 알게 되었다.


그럼 이만 Socket Test 하러... 슝~!




행복한 고수되셔요.


woojja ))*

\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\




Posted by woojja
이전버튼 1 이전버튼