معرفی
Swagger چارچوبی است که برای مستندسازی APIهای وب استفاده می شود. در این مقاله، ما میخواهیم ببینیم که چگونه Swagger را برای Web API خود که با استفاده از ASP.NET Core 2.2 توسعه داده شده است، فعال کنیم.
پیش نیازها
اگر با ASP.NET Core API تازه کار هستید، لطفاً مقاله
قبلی من را مطالعه کنید، جایی که من نحوه شروع کار با پروژه های ASP.NET Core API را توضیح داده ام.
قبلی من را مطالعه کنید، جایی که من نحوه شروع کار با پروژه های ASP.NET Core API را توضیح داده ام.
ابزار سازی
ویژوال استودیو 2017 به بعد
Swagger در ASP.NET Core API 2.2
من یک برنامه ASP.NET Core 2.2 API با استفاده از Visual Studio 2019 ایجاد کرده ام.
کلاس مدل، Employee.cs
- public class Employee
- {
- [Key]
- public int EmployeeID { get; set; }
- public string Name { get; set; }
- }
کلاس زمینه، EmployeeContext.cs
- public class EmployeeContext : DbContext
- {
- public EmployeeContext(DbContextOptions options) : base(options)
- {
- }
- public DbSet<Employee> Employees { get; set; }
- }
ما با استفاده از رویکرد Entity Framework Core Core-first که در مقاله
قبلی خود توضیح داده ام، با پایگاه داده SQL back-end مرتبط هستیم .
قبلی خود توضیح داده ام، با پایگاه داده SQL back-end مرتبط هستیم .