اشتراکها
Asp.NetCore تابعی (Functional)!
اشتراکها
چک لیست امنیتی HTML5
اشتراکها
Let's Encrypt ثبت نام میکند
اشتراکها
Heartbleed و static analysis
در کدهای فوق این تغییر را اعمال کنید (تعیین زمان بررسی مجدد معتبر بودن security stamp کاربر):
یک مثال
validateInterval: TimeSpan.FromSeconds(0)
در مطالب گذشته، دربارهی پیاده سازی API Versioning در ASP.NET Web API و الزامات استفادهی از آن، صحبت شدهاست. اگر مطلب ذکر شده را مطالعه کنید، میبینید که پیاده سازی Versioning در ASP.NET Web API کاری دشوار و زمانبر بود؛ اما در ASP.NET Core انجام تمامی آن مراحل، در 1 خط صورت میگیرد که در ادامه آن را بررسی میکنیم.
بعد از نصب، کافیست کد زیر را داخل متد ConfigureServices در فایل Startup.cs پروژهی خود اضافه کنید:
پارامتر DefaultApiVersion را برابر با یک ApiVersion قرار دادهایم. کلاس ApiVersion دارای Overloadهای مختلفی است. Overload ای را که ما در اینجا از آن استفاده کردهایم، بعنوان پارامتر اول Major Version و برای پارامتر دوم، Minor Version را میگیرد. همچنین بجای Major و Minor میتوان از یک DateTime بعنوان ورژن استفاده کرد:
و در این صورت API شما به شکل زیر قابل دسترسی میباشد:
با انجام این تغییر، برای تست API خود دیگر نمیتوانید از Browser استفاده کنید که این یکی از مشکلات این روش است. برای تست کردن یک درخواست GET ساده مجبور به استفاده از ابزارهایی همچون Postman, CURL و ... هستید. ما در اینجا برای تست از Postman استفاده میکنیم:
Deprecating
که در نتیجهی آن، Response Header برگشتی به این شکل خواهد بود :
Ignoring Versioning
اجرای این متد در صورت غیرفعال بودن AssumeDefaultVersionWhenUnspecified باعث وقوع خطای NullReferenceException میشود و بدین معناست که همانطور که انتظار داشتیم، Version ای برای این Endpoint تنظیم نشده است.
مطلب تکمیلی:
برای شروع با اجرای این دستور در Package Manager Console، پکیج Microsoft.AspNetCore.Mvc.Versioning را داخل پروژه نصب میکنیم:
Install-Package Microsoft.AspNetCore.Mvc.Versioning
public void ConfigureServices(IServiceCollection services) { services.AddMvc(); services.AddApiVersioning(); // ... }
در ابتدا بعد از نصب این پکیج، ممکن است شما API هایی داشته باشید که برای آنها از قبل ورژنی مشخص نکرده باشید (بصورت explicit ). میتوانید یک Version پیشفرض را به برنامه اضافه کرده و برای Endpoint هایی که ورژن ندارند، از آن استفاده کنید :
services.AddApiVersioning(opt => { opt.AssumeDefaultVersionWhenUnspecified = true; opt.DefaultApiVersion = new ApiVersion(1, 0); });
در این صورت، API شما به شکل زیر قابل دسترسی خواهد بود:
- api/foo?api-version=1.0/
opt.DefaultApiVersion = new ApiVersion(new DateTime(2018, 10, 22));
- api/foo?api-version=2018-10-22/
URL Path Segment Versioning
تا به اینجا API Versioning ما بر اساس Query String Parameters انجام میشود؛ اما اگر بخواهیم بجای آن به شکل مقابل به APIهای خود دسترسی داشته باشیم چطور؟ : api/v1/foo/
برای پیاده سازی به این صورت، کافیست Route کنترلر خود را به این شکل تغییر دهید:
[Route("api/v{version:apiVersion}/[controller]")] public class FooController : ControllerBase { public ActionResult<IEnumerable<string>> Get() { return new[] { "value1", "value2" }; } }
Header Versioning
روش سوم انجام Versioning، استفاده از Header است. برای فعال کردن Header Versioning، داخل Startup، کد خود را به شکل زیر تغییر دهید:
public void ConfigureServices(IServiceCollection services) { services.AddMvc(); services.AddApiVersioning(opt => opt.ApiVersionReader = new HeaderApiVersionReader("api-version")); }
Deprecating
ممکن است بخواهید یک ورژن را منسوخ دانسته و آن را Deprecate کنید. دقت کنید که Deprecate کردن یک API، به معنی از کار افتادن آن نیست. به این صورت میتوانید یک Endpoint از برنامه خود را Deprecate شده «معرفی» کنید:
[ApiVersion("2")] [ApiVersion("1", Deprecated = true)] [Route("api/v{version:apiVersion}/[controller]")] public class FooController : ControllerBase { [HttpGet] public string Get() => "I'm deprecated, Bye bye :("; [HttpGet, MapToApiVersion("2.0")] public string GetV2() => "Hello world ! :D"; }
برای برگرداندن نام APIها و وضعیت Support شان داخل Response Header، باید ReportApiVersions فعال شود:
services.AddApiVersioning(opt => { opt.DefaultApiVersion = new ApiVersion(1, 0); opt.AssumeDefaultVersionWhenUnspecified = true; opt.ReportApiVersions = true; });
Ignoring Versioning
اگر داخل برنامهی خود، کنترلری را دارید که در طی زمان آپدیت نشده و تغییر نخواهد کرد، میتوانید از Version زدن آن با استفاده از ApiVersionNeutral جلوگیری کنید:
[ApiVersionNeutral] [Route("api/[controller]")] public class BarController : ControllerBase { public string Get() => HttpContext.GetRequestedApiVersion().ToString(); }
مطلب تکمیلی:
برای آپدیت کردن و یا معرفی نسخهی جدیدی از یک کنترلر با ورژنی متفاوت، نیازی به Rename کردن کلاس قبلی برای رفع Conflict با نام فایل جدید نیست؛ با استفاده از namespaceها میتوانید کنترلری همنام، اما با ورژن و عملکردی متفاوت داشته باشید:
namespace TestVersioning.Controllers.V1 { [ApiVersion("1", Deprecated = true)] [Route("api/v{version:apiVersion}/[controller]")] public class FooController : ControllerBase { public string Get() => "I'm deprecated, Bye bye :("; } } namespace TestVersioning.Controllers.V2 { [ApiVersion("2")] [Route("api/v{version:apiVersion}/[controller]")] public class FooController : ControllerBase { public string GetV2() => "Hello world ! :D"; } }
در قسمت قبلی
شما را با DataTables آشنا کردم. به طور خلاصه نحوه اعمال کردن
DataTables به یک جدول ساده html را گفتیم که با این کار به صورت پیش
فرض، امکاناتی مثل فیلتر کردن داده ها، صفحه بندی و مرتب سازی آنها و نیز
اعمال شدن استایلهای css به همین جدول html خام اضافه میشود. نکته مهم در
مثال قبلی این بود که دادههای درون این جدول با کدنویسی خام html فراهم
شدند، اما این را در نظر داشته باشید که اکثریت مواقع باید دادهها از یک
بانک اطلاعاتی دریافت شوند و سپس درون جدول قرار بگیرند.
در این قسمت سعی خواهیم کرد تا منبع داده جدول را یک آرایه جاوا اسکریپتی و سپس کالکشنی از آبجکتهای جاوا اسکریپتی (json) در نظر بگیریم و نیز برخی ویژگیهای پیش فرض پلاگین را غیر فعال نمائیم.
فرض کنید میخواهید لیستی از اطلاعات دانشجویان شامل نام (FirstName)، نام خانوادگی (LastName)، و سن (Age) را نمایش دهید. اطلاعات قرار است در جدول زیر قرار بگیرند:
مشاهده میکنید که این جدول فقط شامل قسمت header است و در بدنه آن هیچ سطری قرار نگرفته است. در این مثال اطلاعات از یک آرایه جاوا اسکریپتی باید خوانده شوند و تبدیل به html شده و در نهایت درون قسمت <tbody></tbody> آن تزریق شوند. خوشبختانه DataTables برای این کار امکانات آماده ای را در اختیار قرار میدهد. این کار بدین صورت قابل انجام است:
شرح کد:
aaData : یک آرایه دو بعدی (که به آن ماتریس یا آرایه ای از آرایهها هم گفته میشود) است که مقادیر سلول هایی را نشان میدهد که در جدول قرار خواهند گرفت. تعداد ستونها در این آرایه دو بعدی باید با تعداد ستونهای جدول html متناظر یکسان باشند.
در مثال بالا از یک ماتریس به عنوان منبع داده استفاده شد. منبع داده میتواند به فرمت json نیز باشد. البته در این صورت باید ستونهای جدول html را هم به پلاگین معرفی کنید، بدین صورت:
aaData : همان طور که گفته شد در این قسمت دیتاهای درون جدول آورده میشوند و در این مثال آنها به فرمت json نوشته شده اند.
aoColumns : در این قسمت باید اسم ستونهای جدول ذکر شوند.
غیرفعال کردن بعضی از ویژگیهای پیش فرض DataTables
همان طور که گفته شد پلاگین DataTables به صورت پیش فرض ویژگیهای مرتب سازی (sorting)، صفحه بندی (paging)، فیلتر کردن دادهها (filtering)، و غیره را به جدول مورد نظرش اعمال میکند. و بدین صورت قابل تغییر است:
bPaginate : بیان میکند آیا صفحه بندی سطرهای جدول فعال باشد یا نه.
bLengthChange : در صورتی که قابلیت صفحه بندی فعال باشد ، بیان میکند که کاربر بتواند اندازه صفحه را تغییر دهد یا نه.
bFilter : بیان میکند آیا قابلیت فیلتر کردن دادهها فعال باشد یا نه.
bSort : بیان میکند قابلیت مرتب سازی دادههای جدول فعال باشد یا نه.
bInfo : بیان میکند که قسمت info زیر گرید نشان داده شود یا نه (در این قسمت اطلاعاتی راجع به تعداد کل رکوردهای بایند شده به جدول و نیز رکوردهای درون صفحه جاری نشان داده میشود)
bAutoWidth : در صورتی که این گزینه فعال باشد اندازه عرض هر ستون به صوتر خودکار توسط DataTables مقدار دهی خواهد شد.
مقدارهای قابل قبول برای هر کدام از این خصوصیات : true یا false
کدهای مربوط به این مثال را میتوانید از لینک زیر دریافت کنید:
DataTables-DoteNetTips-Tutorial-02.zip
در این قسمت سعی خواهیم کرد تا منبع داده جدول را یک آرایه جاوا اسکریپتی و سپس کالکشنی از آبجکتهای جاوا اسکریپتی (json) در نظر بگیریم و نیز برخی ویژگیهای پیش فرض پلاگین را غیر فعال نمائیم.
فرض کنید میخواهید لیستی از اطلاعات دانشجویان شامل نام (FirstName)، نام خانوادگی (LastName)، و سن (Age) را نمایش دهید. اطلاعات قرار است در جدول زیر قرار بگیرند:
<table id="std-grid"> <thead> <th>نام</th> <th>نام خانوادگی</th> <th>سن</th> </thead> <tbody> </tbody> </table>
مشاهده میکنید که این جدول فقط شامل قسمت header است و در بدنه آن هیچ سطری قرار نگرفته است. در این مثال اطلاعات از یک آرایه جاوا اسکریپتی باید خوانده شوند و تبدیل به html شده و در نهایت درون قسمت <tbody></tbody> آن تزریق شوند. خوشبختانه DataTables برای این کار امکانات آماده ای را در اختیار قرار میدهد. این کار بدین صورت قابل انجام است:
<script> $(document).ready(function() { $('#std-grid').dataTable({ "aaData": [ ["پژمان", "پارسائی", "24"], ["سعید", "الیاسی", "25"], ["محمد رضا", "گلزار", "20"], ["آرش", "ایرانی", "19"], ["مرتضی", "فرمانی", "22"], ["سعید", "حمیدیان", "23"], ["امین", "پارسانیا", "23"], ["محمد امین", "فقیهی", "24"], ["محمد", "خرمی", "25"], ["سینا", "امیریان", "20"], ["آرش", "ایرانی", "19"], ["وحید", "فرزانه", "22"], ["امیر علی", "فرمانی", "23"], ["امین", "حسینی", "23"], }); }); </script>
aaData : یک آرایه دو بعدی (که به آن ماتریس یا آرایه ای از آرایهها هم گفته میشود) است که مقادیر سلول هایی را نشان میدهد که در جدول قرار خواهند گرفت. تعداد ستونها در این آرایه دو بعدی باید با تعداد ستونهای جدول html متناظر یکسان باشند.
در مثال بالا از یک ماتریس به عنوان منبع داده استفاده شد. منبع داده میتواند به فرمت json نیز باشد. البته در این صورت باید ستونهای جدول html را هم به پلاگین معرفی کنید، بدین صورت:
$(document).ready(function() { $('#std-grid').dataTable({ "aaData": [ {"FirstName" : "پژمان", "LastName" : "پارسائی", "Age" : "24"}, { "FirstName": "سعید", "LastName": "الیاسی", "Age": "25" }, { "FirstName": "محمد رضا", "LastName": "گلزار", "Age": "24" }, { "FirstName": "آرش", "LastName": "ایرانی", "Age": "24" }, { "FirstName": "مرتضی", "LastName": "فرمانی", "Age": "24" }, { "FirstName": "سعید", "LastName": "حمیدیان", "Age": "24" }, { "FirstName": "امین", "LastName": "پارسانیا", "Age": "24" }, { "FirstName": "محمد امین", "LastName": "فقیهی", "Age": "24" }, { "FirstName": "محمد", "LastName": "خرمی", "Age": "24" }, { "FirstName": "سینا", "LastName": "امیریان", "Age": "24" }, { "FirstName": "آرش", "LastName": "ایرانی", "Age": "24" }, { "FirstName": "وحید", "LastName": "فرزانه", "Age": "24" }, { "FirstName": "امیر علی", "LastName": "فرمانی", "Age": "24" }, { "FirstName": "امین", "LastName": "حسینی", "Age": "24" }, ], "aoColumns": [ { "mDataProp": "FirstName" }, { "mDataProp": "LastName" }, { "mDataProp": "Age" } ] }); });
aoColumns : در این قسمت باید اسم ستونهای جدول ذکر شوند.
غیرفعال کردن بعضی از ویژگیهای پیش فرض DataTables
همان طور که گفته شد پلاگین DataTables به صورت پیش فرض ویژگیهای مرتب سازی (sorting)، صفحه بندی (paging)، فیلتر کردن دادهها (filtering)، و غیره را به جدول مورد نظرش اعمال میکند. و بدین صورت قابل تغییر است:
$('#std-grid').dataTable({ "bPaginate": false, "bLengthChange": false, "bFilter": false, "bSort": false, "bInfo": true, "bAutoWidth": false });
bLengthChange : در صورتی که قابلیت صفحه بندی فعال باشد ، بیان میکند که کاربر بتواند اندازه صفحه را تغییر دهد یا نه.
bFilter : بیان میکند آیا قابلیت فیلتر کردن دادهها فعال باشد یا نه.
bSort : بیان میکند قابلیت مرتب سازی دادههای جدول فعال باشد یا نه.
bInfo : بیان میکند که قسمت info زیر گرید نشان داده شود یا نه (در این قسمت اطلاعاتی راجع به تعداد کل رکوردهای بایند شده به جدول و نیز رکوردهای درون صفحه جاری نشان داده میشود)
bAutoWidth : در صورتی که این گزینه فعال باشد اندازه عرض هر ستون به صوتر خودکار توسط DataTables مقدار دهی خواهد شد.
مقدارهای قابل قبول برای هر کدام از این خصوصیات : true یا false
کدهای مربوط به این مثال را میتوانید از لینک زیر دریافت کنید:
DataTables-DoteNetTips-Tutorial-02.zip