در این پست از وبسایت پرووید در رابطه با ساخت یک پروژه ASP.NET Web API به صورت Stand-alone صحبت خواهیم کرد.

ساخت یک پروژه Web API به صورت Stand-alone

در ادامه این آموزش از وب سایت پرووید در رابطه با ساخت یک پروژه Web API به صورت Stand-alone و بدون استفاده کردن از MVC صحبت خواهیم کرد. به این منظور ابتدا ویژوال استودیو را باز کرده و به منوی File بروید و سپس New Project را انتخاب کنید. این موضوع باعث می شود که پنجره New Project شبیه به تصویر زیر نشان داده شود.

در این پنجره بر روی گزینه Web از سمت چپ و گزینه ASP.NET Web Application از سمت راست کلیک کنید. سپس یک نام برای پروژه در نظر گرفته و بر روی دکمه OK کلیک کنید. این موضوع باعث می شود که پنجره زیر نشان داده شود.

در این پنجره بر روی گزینه Empty کلیک کرده و سپس بر روی OK کلیک کنید. این باعث می شود که یک پروژه خالی برای شما ساخته شود. در ادامه باید تمامی رفرنس های مربوط به Web API را با استفاده از NuGet Package Manager به پروژه خود اضافه کنید.

آموزش ساخت Web API در ASP.NET Core 2.0

از شما دعوت می کنیم از بسته ی آموزش ساخت Web API در ASP.NET Core 2.0 دیدن کنید.

برای این کار بر روی پروژه راست کلیک کرده و سپس گزینه Manage NuGet Packages را انتخاب کنید.

در پنجره Manage NuGet Packages بر روی قسمت Online از سمت چپ کلیک کرده و کلمه webapi را جستجو کنید. با استفاده از این کار تمامی پکیج های مربوط به Web API نمایش داده می شوند. پکیج Microsoft ASP.NET Web API2.2 را انتخاب کنید و بر روی دکمه Install کلیک کنید.

پس از پایان نصب پکیج های مورد نیاز تصویر زیر نشان دهنده پکیج هایی است که در پروژه جدید شما نصب شده اند.

پس از آن دو فولدر با نام های Controllers و Configuration به پروژه خود اضافه کنید. در درون فولدر Controllers فایلهای Controller ها را قرار می دهیم و در فولدر Configuration فایل های مربوط به پیکربندی را قرار می دهیم.

در ادامه یک کلاس با نام HelloWebAPIConfig در درون فولدر Configuration قرار دهید. علاوه بر این نام می توانید هر نوع دیگری را برای این کلاس در نظر بگیرید.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;

namespace HelloWebAPI.Configuration
{
    public static class HelloWebAPIConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API routes
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }
}

پس از آن یک فایل Global.asax را به پروژه خود اضافه کنید. برای انجام این کار بر روی پروژه راست کلیک کرده و سپس گزینه Add را انتخاب کنید و بعد از آن بر روی New Item کلیک کنید. سپس یک فایل Global Application Class را به پروژه اضافه کنید. تصویر زیر این موضوع را نشان می دهد.

با استفاده از این کار یک فایل Global.asax به پروژه شما اضافه می شود. برای انجام پیکربندی های مربوط به Route های Web API از متد HelloWebAPIConfig.Register در درون رویداد Application_Start از این فایل استفاده کنید. این موضوع در تصویر زیر نشان داده شده است.

public class Global : System.Web.HttpApplication
{
    protected void Application_Start(object sender, EventArgs e)
    {
        GlobalConfiguration.Configure(HelloWebAPIConfig.Register);
    }
}

پس از آن با استفاده از راست کلیک کردن بر روی فولدر Controllers و انتخاب Add New Item می توانید یک Web API Controller جدید را به پروژه خود اضافه کنید.

نام Controller جدید را HelloController بگذارید. کد زیر محتوای مربوط به این Controller را نشان می دهد.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;

namespace HelloWebAPI.Controller
{
    public class HelloController : ApiController
    {
       
    }
}

برای اضافه کردن یک Action Method در درون این Controller می توانید شبیه به کد زیر عمل کنید.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;

namespace HelloWebAPI.Controller
{
    public class HelloController : ApiController
    {
        public string Get()
        {
            return "Hello World";
        }
    }
}

در درون این کد ما یک متد با نام Get را تعریف کرده ایم که یک مقدار از نوع string را بر میگرداند. پس از آن برنامه خود را کامپایل کرده و آن را اجرا کنید و به آدرس http://localhost:xxxx/api/hello در درون مرورگر خود بروید. دقت کنید که xxxx همان Port Number می باشد که ممکن است در سیستم شما یک مقدار متفاوت باشد. می‌بینید که خروجی متد Get در قالب یک نوع داده ای string در درون مرورگر نشان داده شده است.

بنابراین با استفاده از این روش می توانید یک پروژه Web API را از ابتدا به صورت Stand-alone بسازید. در قسمت بعدی از این آموزش در رابطه با تست کردن نتایج بازگشت داده شده از Web API صحبت خواهیم کرد. این موضوع یک تکنیک بسیار مهم در توسعه Web API می باشد.

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *