ASP.NET Web API یک چارچوب قابل توسعه برای ساخت سرویس های مبتنی بر HTTP است که در برنامه های مختلف در پلتفرم های مختلف مانند وب، ویندوز، موبایل و غیره قابل دسترسی است. فقط از پروتکل HTTP پشتیبانی می کند.
بنابراین اکنون، پرس و جو این است که چه زمانی باید از Web API استفاده کرد
زمانی که می خواهید سرویسی بسازید که فقط از پروتکل HTTP پشتیبانی می کند، برای ساخت سرویس های RESTful، از Web API استفاده کنید.
Swagger یک فرمت توضیحات API برای REST API است. Swagger مجموعه ای از ابزارهای منبع باز است که به شما امکان می دهد API های REST را بسازید، طراحی کنید، مستند کنید و مصرف کنید.
عملاً ببینیم.
یک پروژه جدید ایجاد کنید.
ASP.NET Web Application (.NET Framework) را انتخاب کنید.
اکنون، ما قالب های مختلف پروژه داریم و برای API، باید Web API را انتخاب کنیم.
- خالی: بدون هیچ فایل پیش فرض.
- فرم های وب: فرم های Asp.net
- MVC: معماری پیشفرض MVC با فایلها
- Web API: فایل کنترلر API با معماری MVC.
HelpPage نیز برای آزمایش API ساخته شده است. میتوانید مستقیماً اجرا کنید و صفحه راهنما را برای آزمایش Web API و پاسخ بررسی کنید. اما ابزار قدرتمند دیگری برای بررسی و آزمایش API وجود دارد که Swagger نام دارد. اکنون Swagger را نصب می کنیم که یک ابزار بسیار قدرتمند برای Web API است.
دو راه برای نصب swagger وجود دارد.
- کنسول NuGet Package Manager Console
NuGet Package Manager را از Tools > NuGet Package Manager > Package Manager Console باز کنید و در پنجره کنسول، دستور زیر را اجرا کنید.
Install-Package Swashbuckle – نسخه 5.2.1
- از Reference
روی Reference کلیک راست کنید > Manage NuGet Packages را انتخاب کنید > در پنجره جدید "Browse" > Search by "Swagger" را انتخاب کنید و روی "Install" کلیک کنید.
پس از نصب بسته، به App_Start در Solution Explorer بروید. شما یک فایل جدید به نام SwaggerConfig.cs پیدا خواهید کرد.
فقط یک برنامه را اجرا کنید و در URL، "/swagger" را اضافه کنید . برای تست API یک swagger پیدا خواهید کرد. ابرداده Swagger را می توان برای گفتن اینکه چگونه با API شما تعامل داشته باشند، مورد استفاده قرار گیرد.
فرم ویدیویی این مقاله در اینجا موجود است .